An open API service indexing awesome lists of open source software.

https://github.com/ickc/so-software-environment

scripts and documentation on bootstrapping a SO software environment in SO:UK.
https://github.com/ickc/so-software-environment

Last synced: about 1 year ago
JSON representation

scripts and documentation on bootstrapping a SO software environment in SO:UK.

Awesome Lists containing this project

README

          

# so-software-environment

scripts and documentation on bootstrapping a SO software environment in SO:UK.

# Creating SO software stack using conda

This is the recommended method if you are developing on your machine. For `simons1`, `soukdev1`, Blackett, SDSC, or NERSC, see relevant sections in SO wiki or talk to respective people in loading maintained SO software environments.

1. install conda/mamba first

2. install SO environment: before you begin, you may want to edit `examples/so.yml` manually if you want to choose a different version of `toast` or `sotodlib` for example.

- create new environment:

- using conda:

```sh
# you may need to activate the base environment first if you haven't done so.
conda activate
# or
. activate
# then
conda env create -f examples/so.yml
conda activate so-310
python -m ipykernel install --user --name so-310 --display-name so-310
```

- using mamba:

```sh
# you may need to activate the base environment first if you haven't done so.
conda activate
# or
. activate
# then
mamba env create -f examples/so.yml
conda activate so-310
python -m ipykernel install --user --name so-310 --display-name so-310
```

- update existing environment:

- using conda: `conda env update --name so-310 --file examples/so.yml --prune`

- using mamba: `mamba env update --name so-310 --file examples/so.yml --prune`

3. (optional) install & development: here we use `sotodlib` as an example:

```sh
# go to some directory that you want to put the git repo first
git clone git@github.com:simonsobs/sotodlib.git
# change branch or tag if you need
# pip install -e .
```

4. running TOAST test to ensure your installation works:

```sh
python -c 'import toast.tests; toast.tests.run()'
```