Skip to content

Commit

Permalink
Update developer's guide
Browse files Browse the repository at this point in the history
  • Loading branch information
xylar committed Jun 25, 2023
1 parent ad40587 commit 6b4c826
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions docs/developers_guide/deploying_spack.rst
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,7 @@ Troubleshooting spack
If you encounter an error like:
.. code-block:: none
==> spack env activate dev_compass_1_2_0-alpha_4_gnu_mpich
==> spack env activate dev_compass_1_2_0-alpha_6_gnu_mpich
==> Error: Package 'armpl' not found.
You may need to run 'spack clean -m'.
Expand All @@ -295,7 +295,7 @@ get the ``spack`` command, e.g.:

.. code-block:: bash
source ${PSCRATCH}/spack_test/spack_for_mache_1.12.0/share/spack/setup-env.sh
source ${PSCRATCH}/spack_test/dev_compass_1_2_0-alpha_6_gnu_mpich/share/spack/setup-env.sh
Then run the suggested command:

Expand Down Expand Up @@ -323,7 +323,7 @@ and serves as kind of a baseline for other testing.
source load_dev_compass_1.2.0-alpha.5_chrysalis_intel_openmpi.sh
git submodule update --init --recursive
cd E3SM-Project/components/mpas-ocean
# this will build with scorpio and openmp
# this will build with PIO and OpenMP
make ifort
compass suite -s -c ocean -t pr -p . \
-w /lcrc/group/e3sm/ac.xylar/compass/test_20230202/ocean_pr_chrys_intel_openmpi
Expand Down Expand Up @@ -392,7 +392,7 @@ branch.
cd ../nonhydro_chrys_intel_openmpi
git submodule update --init --recursive
cd components/mpas-ocean
# this will build with scorpio, Netlib LAPACK and PETSc
# this will build with PIO, Netlib LAPACK and PETSc
make ifort
compass list | grep nonhydro
# update these numbers for the 2 nonhydro test cases
Expand Down
10 changes: 5 additions & 5 deletions docs/developers_guide/quick_start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -181,8 +181,8 @@ you, this script will also:
``--spack`` flag can be used to point to a location for the spack repo to be
checked out. Without this flag, a default location is used. Spack is used to
build several libraries with system compilers and MPI library, including:
`SCORPIO <https://github.com/E3SM-Project/scorpio>`_ (parallel i/o for MPAS
components) `ESMF <https://earthsystemmodeling.org/>`_ (making mapping files
`ParallelIO <https://github.com/NCAR/ParallelIO>`_ (parallel i/o in NetCDF
format) `ESMF <https://earthsystemmodeling.org/>`_ (making mapping files
in parallel), `Trilinos <https://trilinos.github.io/>`_,
`Albany <https://github.com/sandialabs/Albany>`_,
`Netlib-LAPACK <http://www.netlib.org/lapack/>`_ and
Expand Down Expand Up @@ -385,8 +385,8 @@ Creating/updating only the compass environment

For some workflows (e.g. for MALI development with the Albany library when the
MALI build environment has been created outside of ``compass``, for example,
on an unsupported machine), you may
only want to create the conda environment and not build SCORPIO, ESMF or
on an unsupported machine), you may only want to create the conda environment
and not build PIO, ESMF or other packages with system compilers, or
include any system modules or environment variables in your activation script.
In such cases, run with the ``--env_only`` flag:

Expand Down Expand Up @@ -529,7 +529,7 @@ Code style for compass
guidelines, the easiest way to stay in compliance as a developer writing new
code or modifying existing code is to use a PEP8 style checker. One option is
to use an IDE with a PEP8 style checker built in, such as
`PyCharm <https://www.jetbrains.com/pycharm/>`_. See
`PyCharm <https://www.jetbrains.com/pycharm/>`_. See
`this tutorial <https://www.jetbrains.com/help/pycharm/tutorial-code-quality-assistance-tips-and-tricks.html>`_
for some tips on checking code style in PyCharm.

Expand Down

0 comments on commit 6b4c826

Please sign in to comment.