diff --git a/docs/developers_guide/machines/index.md b/docs/developers_guide/machines/index.md index 72f74405b..c84cec097 100644 --- a/docs/developers_guide/machines/index.md +++ b/docs/developers_guide/machines/index.md @@ -16,8 +16,8 @@ test cases are configured in a way that is appropriate for your machine. If you follow the procedure in {ref}`dev-conda-env`, you will have an activation script for activating the development conda environment, setting loading system modules and setting environment variables so you can build -MPAS and work with polaris. Just source the script that should appear in -the base of your polaris branch, e.g.: +Omega or an MPAS component and work with polaris. Just source the script that +should appear in the base of your polaris branch, e.g.: ```bash source load_dev_polaris_0.1.0-alpha.1_anvil_intel_impi.sh @@ -31,10 +31,25 @@ you were setting things up. You can can source this file on a compute node MPI libraries and environment variables for running polaris tasks and the MPAS model. -:::{note} -Albany (and therefore most of the functionality in MALI) is currently only -supported for those configurations with `gnu` compilers. -::: +Below are specifics for each supported machine + +```{toctree} +:titlesonly: true + +anvil +chicoma +chrysalis +compy +frontier +perlmutter +``` + +(dev-mpas-supported-machines)= + +### MPAS-Ocean and -Seaice Supported Machines + +These are the machines supported by MPAS-Ocean and -Seaice, including the +"make target" used to build the MPAS component. ```{eval-rst} +--------------+------------+-----------+-------------------+ @@ -64,19 +79,51 @@ supported for those configurations with `gnu` compilers. +--------------+------------+-----------+-------------------+ ``` -Below are specifics for each supported machine +(dev-omega-supported-machines)= -```{toctree} -:titlesonly: true +### Omega Supported Machines -anvil -chicoma -chrysalis -compy -frontier -perlmutter +These are the machines supported by Omega. The MPI library is always the +E3SM default for the given machine an compiler. + +```{eval-rst} ++--------------+--------------+-----------+ +| Machine | Compiler | MPI lib. | ++==============+==============+===========+ +| chicoma-cpu | gnu | mpich | ++--------------+--------------+-----------+ +| chrysalis | intel | openmpi | +| +--------------+-----------+ +| | gnu | openmpi | ++--------------+--------------+-----------+ +| frontier | gnu | mpich | +| +--------------+-----------+ +| | gnugpu | mpich | +| +--------------+-----------+ +| | amdclang | mpich | +| +--------------+-----------+ +| | amdclanggpu | mpich | +| +--------------+-----------+ +| | crayclang | mpich | +| +--------------+-----------+ +| | crayclanggpu | mpich | ++--------------+--------------+-----------+ +| pm-cpu | gnu | mpich | +| +--------------+-----------+ +| | intel | mpich | +| +--------------+-----------+ +| | nvidia | mpich | ++--------------+--------------+-----------+ +| pm-gpu | gnugpu | mpich | +| +--------------+-----------+ +| | nvidiagpu | mpich | ++--------------+--------------+-----------+ ``` +:::{note} +Omega does not currently support Compy and Anvil. +::: + (dev-other-machines)= ## Other Machines diff --git a/docs/developers_guide/quick_start.md b/docs/developers_guide/quick_start.md index 75ca73801..9e4613b50 100644 --- a/docs/developers_guide/quick_start.md +++ b/docs/developers_guide/quick_start.md @@ -458,13 +458,15 @@ be safe. ## Building E3SM components There are 3 E3SM repositories that are submodules within the polaris -repository. +repository, but the MALI-Dev submodule is not yet used. -For MPAS-Ocean and MALI both, see the last column of the table in -{ref}`dev-supported-machines` for the right `` command for -each machine and compiler. +(dev-mpas-build)= + +### MPAS-Ocean or MPAS-Seaice -### MPAS-Ocean +For MPAS-Ocean and -Seaice both, see the last column of the table in +{ref}`dev-mpas-supported-machines` for the right `` command for +each machine and compiler. To build MPAS-Ocean, you would typically run: @@ -474,27 +476,15 @@ cd e3sm_submodules/E3SM-Project/components/mpas-ocean/ make ``` -### MALI +The same applies to MPAS-Seaice except with `mpas-seaice` in the path above. -MALI should typically be compiled with the Albany library that contains the -first-order velocity solver. The Albany first-order velocity solver is the -only velocity option that is scientifically validated. On supported machines -and with compilers that support albany, you can run: - -```bash -./configure_polaris_envs.py --with_albany ... -``` - -Then, you can build MALI: - -```bash -source ./load_____albany.sh -cd e3sm_submodules/MALI-Dev/components/mpas-albany-landice -make ALBANY=true -``` +(dev-omega-build)= ### Omega +See the table in {ref}`dev-omega-supported-machines` for a list of supported +machines. + If you simply wish to run the CTests from Omega, you likely want to use the [Omega CTest Utility](https://github.com/E3SM-Project/polaris/blob/main/utils/omega/ctest/README.md).