aboutsummaryrefslogtreecommitdiff
path: root/mission
diff options
context:
space:
mode:
authorJoseph Hunkeler <jhunkeler@gmail.com>2024-02-13 00:14:11 -0500
committerJoseph Hunkeler <jhunkeler@gmail.com>2024-02-13 00:14:11 -0500
commit8d924982d713d564880b5d2ea2b0ab888d12accb (patch)
tree866d6378c1bc7458a54c819b6c86d6ea1c27e0fc /mission
parent48db0b38cee0b9ace130fa90c0df1c9cb490c570 (diff)
downloadstasis-8d924982d713d564880b5d2ea2b0ab888d12accb.tar.gz
Update all mission templates
Diffstat (limited to 'mission')
-rw-r--r--mission/hst/readme.md.in50
-rw-r--r--mission/hst/release_notes.md.in4
-rw-r--r--mission/jwst/readme.md.in6
-rw-r--r--mission/jwst/release_notes.md.in4
-rw-r--r--mission/roman/readme.md.in50
-rw-r--r--mission/roman/release_notes.md.in4
6 files changed, 116 insertions, 2 deletions
diff --git a/mission/hst/readme.md.in b/mission/hst/readme.md.in
new file mode 100644
index 0000000..0d71e38
--- /dev/null
+++ b/mission/hst/readme.md.in
@@ -0,0 +1,50 @@
+# {{meta.name}} {{meta.version}}
+
+Currently, conda is required to manage installation of the environment.
+A fresh installation of Anaconda3 or Miniconda3 is not required for
+each {{meta.name}} release, however. An existing conda installation may be
+used. The method described here allows for multiple, entirely segregated,
+pipeline installations.
+
+A `bash`-compatible shell 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.
+
+## For existing conda installations:
+
+### Install the pipeline environment
+```
+$ curl -O https://ssb.stsci.edu/releases/{{meta.name}}/{{meta.version}}/latest-linux.yml
+$ conda env create --file latest-linux.yml
+```
+### Activate the pipeline environment
+
+```
+$ conda activate {{info.release_name}}
+```
+
+Each new delivery iteration of the calibration environment will need to be
+installed using the above commands.
+
+------
+
+## If conda is not yet installed
+
+If the conda tool is not available on the target system, it will need to be
+installed before the calibration environment can be installed.
+
+### Installing conda
+
+For detailed instructions of this step, please visit:
+https://conda.io/projects/conda/en/latest/user-guide/install/index.html
+
+**Miniconda:**
+
+```
+# TODO: UPDATE THIS
+$ 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
+``` \ No newline at end of file
diff --git a/mission/hst/release_notes.md.in b/mission/hst/release_notes.md.in
new file mode 100644
index 0000000..372b5c4
--- /dev/null
+++ b/mission/hst/release_notes.md.in
@@ -0,0 +1,4 @@
+# Release Notes
+
+**{{meta.name}} {{meta.version}}**
+
diff --git a/mission/jwst/readme.md.in b/mission/jwst/readme.md.in
index f730f79..c47637b 100644
--- a/mission/jwst/readme.md.in
+++ b/mission/jwst/readme.md.in
@@ -1,3 +1,5 @@
+# {{meta.name}} {{meta.version}}
+
Currently, conda is required to manage installation of the environment.
A fresh installation of Anaconda3 or Miniconda3 is not required for
each {{meta.name}} release, however. An existing conda installation may be
@@ -14,8 +16,8 @@ specification file and then creating the environment with it.
### Install the pipeline environment
```
-$ curl -O https://ssb.stsci.edu/releases/{{meta.name}}/{{meta.version}}/latest-linux.yml
-$ conda env create --file latest-linux.yml
+$ curl -O https://ssb.stsci.edu/releases/{{meta.name}}/{{meta.version}}/{{info.release_name}}.yml
+$ conda env create --file {{info.release_name}}.yml
```
### Activate the pipeline environment
diff --git a/mission/jwst/release_notes.md.in b/mission/jwst/release_notes.md.in
new file mode 100644
index 0000000..372b5c4
--- /dev/null
+++ b/mission/jwst/release_notes.md.in
@@ -0,0 +1,4 @@
+# Release Notes
+
+**{{meta.name}} {{meta.version}}**
+
diff --git a/mission/roman/readme.md.in b/mission/roman/readme.md.in
new file mode 100644
index 0000000..0d71e38
--- /dev/null
+++ b/mission/roman/readme.md.in
@@ -0,0 +1,50 @@
+# {{meta.name}} {{meta.version}}
+
+Currently, conda is required to manage installation of the environment.
+A fresh installation of Anaconda3 or Miniconda3 is not required for
+each {{meta.name}} release, however. An existing conda installation may be
+used. The method described here allows for multiple, entirely segregated,
+pipeline installations.
+
+A `bash`-compatible shell 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.
+
+## For existing conda installations:
+
+### Install the pipeline environment
+```
+$ curl -O https://ssb.stsci.edu/releases/{{meta.name}}/{{meta.version}}/latest-linux.yml
+$ conda env create --file latest-linux.yml
+```
+### Activate the pipeline environment
+
+```
+$ conda activate {{info.release_name}}
+```
+
+Each new delivery iteration of the calibration environment will need to be
+installed using the above commands.
+
+------
+
+## If conda is not yet installed
+
+If the conda tool is not available on the target system, it will need to be
+installed before the calibration environment can be installed.
+
+### Installing conda
+
+For detailed instructions of this step, please visit:
+https://conda.io/projects/conda/en/latest/user-guide/install/index.html
+
+**Miniconda:**
+
+```
+# TODO: UPDATE THIS
+$ 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
+``` \ No newline at end of file
diff --git a/mission/roman/release_notes.md.in b/mission/roman/release_notes.md.in
new file mode 100644
index 0000000..372b5c4
--- /dev/null
+++ b/mission/roman/release_notes.md.in
@@ -0,0 +1,4 @@
+# Release Notes
+
+**{{meta.name}} {{meta.version}}**
+