aboutsummaryrefslogtreecommitdiff
path: root/mission/jwst/readme.md.in
blob: c1052f091517c06b85d39f9072ff51d14411070a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# {{ 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_compact }} \
    --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_compact }}
```

------

Each new delivery iteration will need to be installed using one of the above commands.

------

# Software Release Notes

{{ func:get_github_release_notes_auto() }}