Skip to content

Commit 665f1e9

Browse files
authored
[develop] Bringing container docs inline with Intel EULA (#1362)
Co-authored-by: Joshua Kublnick <joshua.kublnick@snhu.edu>
1 parent f56eb59 commit 665f1e9

1 file changed

Lines changed: 18 additions & 26 deletions

File tree

doc/UsersGuide/BuildingRunningTesting/ContainerQuickstart.rst

Lines changed: 18 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ consistent workflows across different systems and cloud platforms.
1414

1515
Two container options are provided:
1616

17-
* **Intel-based container:** uses Intel compilers and Intel MPI.
17+
* **Intel-based container:** uses Intel compilers and MPI to build and Intel runtime environment to run.
1818
* **GNU-based container:** uses fully open-source GNU compilers and OpenMPI.
1919

2020
Additional differences between the containers are that the Intel-based image includes pre-built SRW App binaries.
@@ -150,8 +150,8 @@ Obtain or Build the Intel-Based Singularity Container
150150
- /glade/work/epicufsrt/contrib/containers
151151
* - Gaea-C6 [#fn]_
152152
- /gpfs/f6/bil-fire8/world-shared/containers
153-
* - Hera
154-
- /scratch1/NCEPDEV/nems/role.epic/containers
153+
* - Ursa
154+
- /scratch3/NCEPDEV/nems/role.epic/containers
155155
* - NOAA Cloud [#fn]_
156156
- /contrib/EPIC/containers
157157
* - Orion/Hercules
@@ -166,36 +166,28 @@ It is practical to set an environment variable to point to the container:
166166

167167
.. code-block:: console
168168
169-
export img=/path/to/ubuntu22.04-intel-ue-1.6.0-srw-dev.img
169+
export img=/path/to/ubuntu22.04-intel-srw-release-public-v3.0.0-rt.img
170170
171171
Users may convert the read-only image in a shared location to a writable sandbox in user's space:
172172

173173
.. code-block:: console
174174
175-
singularity build --sandbox ubuntu22.04-intel-ue-1.6.0-srw-dev $img
175+
singularity build --sandbox ubuntu22.04-intel-srw-release-public-v3.0.0-rt $img
176176
177177
Signature warnings may be ignored.
178178

179179
**On Level 2–4 systems**, build a sandbox directly from the Docker Hub repository:
180180

181181
.. code-block:: console
182182
183-
singularity build --sandbox ubuntu22.04-intel-ue-1.6.0-srw-dev \
184-
docker://noaaepic/ubuntu22.04-intel21.10-srw:ue160-fms202401-dev
183+
singularity build --sandbox ubuntu22.04-intel-srw-release-public-v3.0.0-rt \
184+
docker://noaaepic/ubuntu22.04-intel2023.2.1-srw:ue160-fms202401-release3-rt
185185
186-
A release-tagged container may be built in a similar way:
186+
Set an environment variable to point to your sandbox container:
187187

188188
.. code-block:: console
189189
190-
singularity build --sandbox ubuntu22.04-intel-srw-release-public-v3.0.0 \
191-
docker://noaaepic/ubuntu22.04-intel21.10-srw:ue160-fms202401-release3
192-
193-
194-
Set an environment variable to point to your sandbox container:
195-
196-
.. code-block:: console
197-
198-
export img=/path/to/ubuntu22.04-intel-ue-1.6.0-srw-dev
190+
export img=/path/to/ubuntu22.04-intel-srw-release-public-v3.0.0-rt
199191
200192
.. _RunContainer:
201193

@@ -255,14 +247,14 @@ where:
255247

256248
* ``-c`` indicates the compiler on the user's local machine (e.g., ``intel/2022.1.2``, ``intel-oneapi-compilers/2022.2.1``, ``intel/2023.2.0``)
257249
* ``-m`` indicates the :term:`MPI` on the user's local machine (e.g., ``impi/2022.1.2``, ``intel-oneapi-mpi/2021.7.1``, ``cray-mpich/8.1.28``)
258-
* ``<platform>`` refers to the local machine (e.g., ``hera``, ``derecho``, ``noaacloud``). See ``MACHINE`` in :numref:`Section %s <user>` for a full list of options.
259-
* ``-i`` indicates the full path to the container image that was built in :numref:`Step %s <BuildC>` (``ubuntu22.04-intel-ue-1.6.0-srw-dev`` or ``ubuntu22.04-intel-ue-1.6.0-srw-dev.img`` by default).
250+
* ``<platform>`` refers to the local machine (e.g., ``ursa``, ``derecho``, ``noaacloud``). See ``MACHINE`` in :numref:`Section %s <user>` for a full list of options.
251+
* ``-i`` indicates the full path to the container image that was built in :numref:`Step %s <BuildC>` (``ubuntu22.04-intel-srw-release-public-v3.0.0-rt`` or ``ubuntu22.04-intel-srw-release-public-v3.0.0-rt.img`` by default).
260252

261-
For example, on Hera, the command would be:
253+
For example, on Ursa, the command would be:
262254

263255
.. code-block:: console
264256
265-
./stage-srw.sh -c=intel/2022.1.2 -m=impi/2022.1.2 -p=hera -i=$img
257+
./stage-srw.sh -c=intel/2022.1.2 -m=impi/2022.1.2 -p=ursa -i=$img
266258
267259
.. attention::
268260

@@ -323,21 +315,21 @@ Follow the steps below to configure the out-of-the-box SRW App case with an auto
323315
.. note::
324316
On Orion, *cron* is only available on the orion-login-1 node, so users will need to work on that node when running *cron* jobs on Orion.
325317

326-
#. Edit the ``task_get_extrn_ics:`` section of the ``config.yaml`` to include the correct data paths to the initial conditions files. For example, on Hera, add:
318+
#. Edit the ``task_get_extrn_ics:`` section of the ``config.yaml`` to include the correct data paths to the initial conditions files. For example, on Ursa, add:
327319

328320
.. code-block:: console
329321
330322
USE_USER_STAGED_EXTRN_FILES: true
331-
EXTRN_MDL_SOURCE_BASEDIR_ICS: /scratch1/NCEPDEV/nems/role.epic/UFS_SRW_data/develop/input_model_data/FV3GFS/grib2/${yyyymmddhh}
323+
EXTRN_MDL_SOURCE_BASEDIR_ICS: /scratch3/NCEPDEV/nems/role.epic/ursa/UFS_SRW_data/develop/input_model_data/FV3GFS/grib2/${yyyymmddhh}
332324
333-
On other systems, users will need to change the path for ``EXTRN_MDL_SOURCE_BASEDIR_ICS`` and ``EXTRN_MDL_SOURCE_BASEDIR_LBCS`` (below) to reflect the location of the system's data. The location of the machine's global data can be viewed :ref:`here <Data>` for Level 1 systems. Alternatively, the user can add the path to their local data if they downloaded it as described in :numref:`Section %s <InitialConditions>`.
325+
On other systems, users will need to change the path for ``EXTRN_MDL_SOURCE_BASEDIR_ICS`` and ``EXTRN_MDL_SOURCE_BASEDIR_LBCS`` (below) to reflect the location of the system's data. The location of the machine's global data can be viewed :ref:`here <Data>` for Level 1 systems. Alternatively, the user can add the path to their local data if they downloaded it as described in :numref:`Section %s <InitialConditions>`.
334326

335-
#. Edit the ``task_get_extrn_lbcs:`` section of the ``config.yaml`` to include the correct data paths to the lateral boundary conditions files. For example, on Hera, add:
327+
#. Edit the ``task_get_extrn_lbcs:`` section of the ``config.yaml`` to include the correct data paths to the lateral boundary conditions files. For example, on Ursa, add:
336328

337329
.. code-block:: console
338330
339331
USE_USER_STAGED_EXTRN_FILES: true
340-
EXTRN_MDL_SOURCE_BASEDIR_LBCS: /scratch1/NCEPDEV/nems/role.epic/UFS_SRW_data/develop/input_model_data/FV3GFS/grib2/${yyyymmddhh}
332+
EXTRN_MDL_SOURCE_BASEDIR_LBCS: /scratch3/NCEPDEV/nems/role.epic/ursa/UFS_SRW_data/develop/input_model_data/FV3GFS/grib2/${yyyymmddhh}
341333
342334
343335
.. _GenerateWorkflowC:

0 commit comments

Comments
 (0)