diff options
author | Joseph Hunkeler <jhunkeler@users.noreply.github.com> | 2024-08-20 10:45:28 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-08-20 10:45:28 -0400 |
commit | 8cc16bef9d4b8d7d9e36cd135fd6a78a8e8a38cf (patch) | |
tree | 6fc4734d87271916f021041a18dd975f4842b602 /mission/generic/readme.md.in | |
parent | 0eda05963f3c70c3969ddd2aa72926b871ef4b07 (diff) | |
download | stasis-8cc16bef9d4b8d7d9e36cd135fd6a78a8e8a38cf.tar.gz |
Update mission configs (#34)
* Clean package caches (saves about 1GB of layer-space)
* Update installation instructions
* Update layout
* Use template variables where appropriate
* Instructions now provide release notes in one place
* Pandoc now uses --standalone
Diffstat (limited to 'mission/generic/readme.md.in')
-rw-r--r-- | mission/generic/readme.md.in | 63 |
1 files changed, 62 insertions, 1 deletions
diff --git a/mission/generic/readme.md.in b/mission/generic/readme.md.in index 616034e..51929a3 100644 --- a/mission/generic/readme.md.in +++ b/mission/generic/readme.md.in @@ -1 +1,62 @@ -# {{ meta.name }}
\ No newline at end of file +# {{ info.release_name }} + +Conda is required to manage installation of the delivery environment. A fresh installation of {{ conda.installer_name }} is not required for each {{ meta.name }} delivery, however. An existing conda installation may be used. The method described here allows for multiple entirely separate pipeline installations. + +A POSIX-compatible shell (e.g. `bash`) is required for all steps below. Python dependencies are taken directly from PyPI or development repositories as needed, so conda's ability to install hybrid conda/pip environments from a YAML specification is used. This requires first downloading the specification file and then creating the environment with it. + +------ + +# Installing Conda + +If conda is not available on the target system, it will need to be installed and configured before the delivery environment can be installed. + +For detailed instructions of this step, please visit: +https://conda.io/projects/conda/en/latest/user-guide/install/index.html + +**{{ conda.installer_name }}:** + +``` +wget {{ conda.installer_baseurl }}/{{ conda.installer_name }}-{{ conda.installer_version }}-{{ conda.installer_platform }}-{{ conda.installer_arch }}.sh +bash {{ conda.installer_name }}-{{ conda.installer_version }}-{{ conda.installer_platform }}-{{ conda.installer_arch }}.sh +$HOME/{{ conda.installer_name }}/condabin/conda init +``` + +# Installing {{ meta.name }} + +## Option 1: Install this delivery + +``` +conda env create \ + --file https://ssb.stsci.edu/stasis/releases/{{ meta.mission }}/{{ info.build_name }}/delivery/{{ info.release_name }}.yml +``` + +### Activate this delivery + +``` +conda activate {{ info.release_name }} +``` + +## Option 2: Install the latest delivery + +**Warning:** The `latest` URL may provide software different than what is presented by the release notes section below! + +``` +conda env create \ + --name {{ meta.name }}-latest-py{{ meta.python_compat }} \ + --file https://ssb.stsci.edu/stasis/releases/{{ meta.mission }}/{{ info.build_name }}/delivery/latest-py{{ meta.python_compact }}-{{ system.platform }}-{{ system.arch }}.yml +``` +### Activate the latest delivery + +``` +conda activate {{ meta.name }}-latest-py{{ meta.python_compat }} +``` + +------ + +Each new delivery iteration will need to be installed using one of the above commands. + +------ + +# Software Release Notes + +{{ func:get_github_release_notes_auto() }} |