Skip to content

Commit 6fb7f20

Browse files
committed
Add creation of load script to User's Quick Start
1 parent b374c25 commit 6fb7f20

File tree

1 file changed

+29
-4
lines changed

1 file changed

+29
-4
lines changed

docs/users_guide/quick_start.rst

+29-4
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ Quick Start for Users
88
compass conda environment
99
-------------------------
1010

11+
E3SM supported machines
12+
~~~~~~~~~~~~~~~~~~~~~~~
13+
1114
For each ``compass`` release, we maintain a
1215
`conda environment <https://docs.conda.io/en/latest/>`_. that includes the
1316
``compass`` package as well as all of its dependencies and some libraries
@@ -68,6 +71,9 @@ for build MPAS components with Gnu compilers and OpenMPI using:
6871
6972
source /lcrc/soft/climate/compass/anvil/load_latest_compass_gnu_openmpi.sh
7073
74+
other machines
75+
~~~~~~~~~~~~~~
76+
7177
To install your own ``compass`` conda environment on other machines, first,
7278
install `Miniconda3 <https://docs.conda.io/en/latest/miniconda.html>`_ (if
7379
miniconda is not already installed), then add the
@@ -83,7 +89,8 @@ follows:
8389

8490
.. code-block:: bash
8591
86-
conda create -n compass -c conda-forge -c e3sm/label/compass python=3.9 "compass=*=mpi_mpich*"
92+
conda create -n compass -c conda-forge -c e3sm/label/compass python=3.9 \
93+
"compass=*=mpi_mpich*"
8794
8895
This will install the version of the package with MPI from conda-forge's MPICH
8996
package. If you want OpenMPI, use ``"compass=*=mpi_openmpi*"`` instead. If
@@ -94,14 +101,32 @@ To get a specific version of ``compass``, you can instead run:
94101

95102
.. code-block:: bash
96103
97-
conda create -n compass -c conda-forge -c e3sm/label/compass python=3.9 "compass=1.0.0=mpi_mpich*"
104+
conda create -n compass -c conda-forge -c e3sm/label/compass python=3.9 \
105+
"compass=1.0.0=mpi_mpich*"
98106
99-
That is, you will replace ``compass=*`` with ``compass=1.0.0``. Each time you
100-
want to work with compass, you will need to run:
107+
That is, you will replace ``compass=*`` with ``compass=1.0.0``.
108+
109+
Then, you will need to create a load script to activate the conda environment
110+
and set some environment variables. In a directory where you want to store the
111+
script, run:
101112

102113
.. code-block:: bash
103114
104115
conda activate compass
116+
create_compass_load_script
117+
118+
From then on, each time you want to set up test cases or suites with compass
119+
or build MPAS components, you will need to source that load script, for
120+
example:
121+
122+
.. code-block:: bash
123+
124+
source load_compass_1.0.0_mpich.sh
125+
126+
When you set up tests, a link called ``load_compass_env.sh`` will be added to
127+
each test case or suite work directory. To run the tests, you may find it
128+
more convenient to source that link instead of finding the path to the original
129+
load script.
105130

106131
.. _build_mpas:
107132

0 commit comments

Comments
 (0)