Skip to content

Commit f29d6d9

Browse files
Update deployment docs (#334)
* Update deployment docs Updated deployment instructions to replace `conda` with `mamba` for environment activation and creation. Replaced `python3` with `python` for pip installations and switched to Miniforge instead of Miniconda. Fixed outdated supervisor URLs for a more accurate reference. * Update docs to reflect change to Miniforge Revised deployment instructions to use Miniforge-pypy3 following the deprecation of Mambaforge in July 2024. Updated activation commands from `conda` to `mamba` throughout for consistency. Adjusted relevant links and clarified environment setup details.
1 parent 10dda58 commit f29d6d9

File tree

3 files changed

+38
-36
lines changed

3 files changed

+38
-36
lines changed

docs/deployment/arbutus_cloud.rst

+17-17
Original file line numberDiff line numberDiff line change
@@ -778,41 +778,41 @@ Fetch and merge changes from the `FVCOM41 repo on GitLab`_ and do a clean build:
778778
Python Packages
779779
===============
780780

781-
Install the `Miniconda`_ environment and package manager:
781+
Install the `Miniforge-pypy3`_ environment and package manager:
782+
783+
.. _Miniforge-pypy3: https://github.com/conda-forge/miniforge
782784

783-
.. _Miniconda: https://docs.conda.io/en/latest/miniconda.html
784785

785786
.. code-block:: bash
786787
787788
$ cd /nemoShare/MEOPAR/nowcast-sys/
788-
$ curl -LO https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
789-
$ bash Miniconda3-latest-Linux-x86_64.sh
789+
$ curl -LO https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge-pypy3-Linux-x86_64.sh
790+
$ bash Miniforge-pypy3-Linux-x86_64.sh
790791
791-
Answer :file:`/nemoShare/MEOPAR/nowcast-sys/miniconda3` when the installer asks for an installation location.
792+
Answer :file:`/nemoShare/MEOPAR/nowcast-sys/miniforge-pypy3` when the installer asks for an installation location.
792793

793-
Answer no when the install asks :guilabel:`Do you wish the installer to initialize Miniconda3 by running conda init? [yes|no]`.
794+
Answer ``yes`` when the install asks :guilabel:`Do you wish to update your shell profile to automatically initialize conda? ... [yes|no]`.
794795

795796
The Python packages that the system depends on are installed in a conda environment with:
796797

797798
.. code-block:: bash
798799
799800
$ cd /nemoShare/MEOPAR/nowcast-sys/
800-
$ conda update -n base -c defaults conda
801-
$ conda env create \
801+
$ mamba env create \
802802
--prefix /nemoShare/MEOPAR/nowcast-sys/nowcast-env \
803803
-f SalishSeaNowcast/envs/environment-prod.yaml
804-
$ source /nemoShare/MEOPAR/nowcast-sys/miniconda3/bin/activate /nemoShare/MEOPAR/nowcast-sys/nowcast-env/
805-
(/nemoShare/MEOPAR/nowcast-sys/nowcast-env)$ python3 -m pip install --editable NEMO_Nowcast/
806-
(/nemoShare/MEOPAR/nowcast-sys/nowcast-env)$ python3 -m pip install --editable moad_tools/
807-
(/nemoShare/MEOPAR/nowcast-sys/nowcast-env)$ python3 -m pip install --editable tools/SalishSeaTools/
804+
$ mamba activate /nemoShare/MEOPAR/nowcast-sys/nowcast-env/
805+
(/nemoShare/MEOPAR/nowcast-sys/nowcast-env)$ python -m pip install --editable NEMO_Nowcast/
806+
(/nemoShare/MEOPAR/nowcast-sys/nowcast-env)$ python -m pip install --editable moad_tools/
807+
(/nemoShare/MEOPAR/nowcast-sys/nowcast-env)$ python -m pip install --editable tools/SalishSeaTools/
808808
(/nemoShare/MEOPAR/nowcast-sys/nowcast-env)$ cd OPPTools/
809809
(/nemoShare/MEOPAR/nowcast-sys/nowcast-env)$ git switch SalishSeaCast-prod
810810
(/nemoShare/MEOPAR/nowcast-sys/nowcast-env)$ cd /nemoShare/MEOPAR/nowcast-sys/
811-
(/nemoShare/MEOPAR/nowcast-sys/nowcast-env)$ python3 -m pip install --editable OPPTools/
812-
(/nemoShare/MEOPAR/nowcast-sys/nowcast-env)$ python3 -m pip install --editable NEMO-Cmd/
813-
(/nemoShare/MEOPAR/nowcast-sys/nowcast-env)$ python3 -m pip install --editable SalishSeaCmd/
814-
(/nemoShare/MEOPAR/nowcast-sys/nowcast-env)$ python3 -m pip install --editable FVCOM-Cmd/
815-
(/nemoShare/MEOPAR/nowcast-sys/nowcast-env)$ python3 -m pip install --editable SalishSeaNowcast/
811+
(/nemoShare/MEOPAR/nowcast-sys/nowcast-env)$ python -m pip install --editable OPPTools/
812+
(/nemoShare/MEOPAR/nowcast-sys/nowcast-env)$ python -m pip install --editable NEMO-Cmd/
813+
(/nemoShare/MEOPAR/nowcast-sys/nowcast-env)$ python -m pip install --editable SalishSeaCmd/
814+
(/nemoShare/MEOPAR/nowcast-sys/nowcast-env)$ python -m pip install --editable FVCOM-Cmd/
815+
(/nemoShare/MEOPAR/nowcast-sys/nowcast-env)$ python -m pip install --editable SalishSeaNowcast/
816816
817817
818818
Environment Variables

docs/deployment/operations.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ and the manager,
3939
are managed by the `supervisor`_ process manager tool.
4040
So is the `sarracenia client`_ that maintains mirrors of the HRDPS forecast files and rivers hydrometric files from the `ECCC MSC datamart service`_.
4141

42-
.. _supervisor: http://supervisord.org/
42+
.. _supervisor: https://supervisord.org/
4343
.. _sarracenia client: https://github.com/MetPX/sarracenia/blob/v2_dev/doc/sr_subscribe.1.rst
4444
.. _ECCC MSC datamart service: https://dd.weather.gc.ca/
4545

@@ -73,7 +73,7 @@ Start it with:
7373
$ source activate /results/nowcast-sys/nowcast-env
7474
(/results/nowcast-sys/nowcast-env)$ supervisorctl --configuration $NOWCAST_CONFIG/supervisord.ini
7575
76-
.. _supervisorctl: http://supervisord.org/running.html#running-supervisorctl
76+
.. _supervisorctl: https://supervisord.org/running.html#running-supervisorctl
7777

7878
See the `supervisorctl`_ docs,
7979
or use the ``help`` command within :command:`supervisorctl` to get information on the available commands.

docs/deployment/skookum.rst

+19-17
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,11 @@ The Python packages that the system depends on are installed in conda environmen
5656

5757
.. note::
5858
In Mar-2022 the Python environment and package management tool used for the system
59-
was changed from Miniconda3 to `Mambaforge-pypy3`_.
59+
was changed from Miniconda3 to Mambaforge-pypy3.
60+
In Oct-2024 it was changed again to `Miniforge-pypy3`_ to reflect the merge of
61+
Mambaforge into Miniforge and the deprecation of mambaforge in Jul-2024.
6062

61-
.. _Mambaforge-pypy3: https://github.com/conda-forge/miniforge
63+
.. _Miniforge-pypy3: https://github.com/conda-forge/miniforge
6264

6365
For the ``SalishSeaCast`` automation system:
6466

@@ -68,18 +70,18 @@ For the ``SalishSeaCast`` automation system:
6870
$ mamba env create \
6971
--prefix /SalishSeaCast/nowcast-env \
7072
-f SalishSeaNowcast/envs/environment-prod.yaml
71-
$ conda activate /SalishSeaCast/nowcast-env
72-
(/SalishSeaCast/nowcast-env)$ python3 -m pip install --editable NEMO_Nowcast/
73-
(/SalishSeaCast/nowcast-env)$ python3 -m pip install --editable moad_tools/
74-
(/SalishSeaCast/nowcast-env)$ python3 -m pip install --editable Reshapr/
75-
(/SalishSeaCast/nowcast-env)$ python3 -m pip install --editable tools/SalishSeaTools/
73+
$ mamba activate /SalishSeaCast/nowcast-env
74+
(/SalishSeaCast/nowcast-env)$ python -m pip install --editable NEMO_Nowcast/
75+
(/SalishSeaCast/nowcast-env)$ python -m pip install --editable moad_tools/
76+
(/SalishSeaCast/nowcast-env)$ python -m pip install --editable Reshapr/
77+
(/SalishSeaCast/nowcast-env)$ python -m pip install --editable tools/SalishSeaTools/
7678
(/SalishSeaCast/nowcast-env)$ cd OPPTools/
7779
(/SalishSeaCast/nowcast-env)$ git switch SalishSeaCast-prod
7880
(/SalishSeaCast/nowcast-env)$ cd /SalishSeaCast/
79-
(/SalishSeaCast/nowcast-env)$ python3 -m pip install --editable OPPTools/
80-
(/SalishSeaCast/nowcast-env)$ python3 -m pip install --editable NEMO-Cmd/
81-
(/SalishSeaCast/nowcast-env)$ python3 -m pip install --editable SalishSeaCmd/
82-
(/SalishSeaCast/nowcast-env)$ python3 -m pip install --editable SalishSeaNowcast/
81+
(/SalishSeaCast/nowcast-env)$ python -m pip install --editable OPPTools/
82+
(/SalishSeaCast/nowcast-env)$ python -m pip install --editable NEMO-Cmd/
83+
(/SalishSeaCast/nowcast-env)$ python -m pip install --editable SalishSeaCmd/
84+
(/SalishSeaCast/nowcast-env)$ python -m pip install --editable SalishSeaNowcast/
8385
8486
For the `sarracenia client`_ that maintains mirrors of the HRDPS forecast files and
8587
rivers hydrometric files from the `ECCC MSC datamart service`_:
@@ -93,7 +95,7 @@ rivers hydrometric files from the `ECCC MSC datamart service`_:
9395
$ mamba env create \
9496
--prefix /SalishSeaCast/sarracenia-env \
9597
-f SalishSeaNowcast/envs/environment-sarracenia.yaml
96-
$ conda activate /SalishSeaCast/sarracenia-env
98+
$ mamba activate /SalishSeaCast/sarracenia-env
9799
(/SalishSeaCast/sarracenia-env)$ sr_subscribe edit credentials.conf # initialize datamart credentials
98100
99101
For the `salishsea-site web app`_ that is mounted at https://salishsea.eos.ubc.ca/:
@@ -106,7 +108,7 @@ For the `salishsea-site web app`_ that is mounted at https://salishsea.eos.ubc.c
106108
$ mamba env create \
107109
--prefix /SalishSeaCast/salishsea-site-env \
108110
-f salishsea-site/envs/environment-prod.yaml
109-
$ conda activate /SalishSeaCast/salishsea-site-env
111+
$ mamba activate /SalishSeaCast/salishsea-site-env
110112
(/SalishSeaCast/salishsea-site-env) $ python3 -m pip install --editable salishsea-site/
111113
112114
@@ -163,7 +165,7 @@ and :command:`unset` them when it is deactivated.
163165
164166
The :file:`/SalishSeaCast/sarracenia-env` environment variables are included in the
165167
:file:`SalishSeaNowcast/envs/environment-sarracenia.yaml` file so that they are managed by
166-
:command:`conda` to automatically :command:`export` the environment variables required by the
168+
:command:`mamba` to automatically :command:`export` the environment variables required by the
167169
sarracenia client when the environment is activated and :command:`unset` them when the
168170
environment is deactivated.
169171
To see the variables and their values:
@@ -172,7 +174,7 @@ To see the variables and their values:
172174
173175
$ cd /SalishSeaCast/sarracenia-env
174176
$ source activate /SalishSeaCast/salishsea-site-env
175-
(/SalishSeaCast/salishsea-site-env) $ conda env config vars list
177+
(/SalishSeaCast/salishsea-site-env) $ mamba env config vars list
176178
177179
178180
:file:`/SalishSeaCast/salishsea-site-env`
@@ -353,7 +355,7 @@ and its dashboard port on 4387:
353355
354356
.. code-block:: bash
355357
356-
$ conda activate /SalishSeaCast/nowcast-env
358+
$ mamba activate /SalishSeaCast/nowcast-env
357359
(/SalishSeaCast/nowcast-env)$ dask scheduler --port 4386 --dashboard-address :4387
358360
359361
Use :kbd:`Control-b ,` to rename the :program:`tmux` terminal to ``dask-scheduler``.
@@ -370,7 +372,7 @@ and launch the 4 :command:`dask worker` processes with these properties:
370372
371373
.. code-block:: bash
372374
373-
$ conda activate /SalishSeaCast/nowcast-env
375+
$ mamba activate /SalishSeaCast/nowcast-env
374376
(/SalishSeaCast/nowcast-env)$ dask worker --nworkers=4 --nthreads=1 --memory-limit 64G \
375377
--local-directory /tmp/SalishSeaCast \
376378
--lifetime 3600 --lifetime-stagger 60 --lifetime-restart \

0 commit comments

Comments
 (0)