Skip to content

Commit 99ccda4

Browse files
committed
Bringing container docs in line with Intel EULA in SRW v3
1 parent 2703eae commit 99ccda4

1 file changed

Lines changed: 11 additions & 17 deletions

File tree

doc/UsersGuide/BuildingRunningTesting/ContainerQuickstart.rst

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
Container-Based Quick Start Guide
55
====================================
66

7-
This Container-Based Quick Start Guide will help users build and run the "out-of-the-box" case for the Unified Forecast System (:term:`UFS`) Short-Range Weather (SRW) Application using a `Singularity/Apptainer <https://apptainer.org/docs/user/1.2/introduction.html>`__ container. The :term:`container` approach provides a uniform enviroment in which to build and run the SRW App. Normally, the details of building and running the SRW App vary from system to system due to the many possible combinations of operating systems, compilers, :term:`MPIs <MPI>`, and package versions available. Installation via container reduces this variability and allows for a smoother SRW App build experience.
7+
This Container-Based Quick Start Guide will help users build and run the "out-of-the-box" case for the Unified Forecast System (:term:`UFS`) Short-Range Weather (SRW) Application using a `Singularity/Apptainer <https://apptainer.org/docs/user/1.2/introduction.html>`__ container. The :term:`container` approach provides a uniform enviroment in which to build and run the SRW App. Normally, the details of building and running the SRW App vary from system to system due to the many possible combinations of operating systems, compilers, :term:`MPIs <MPI>`, and package versions available. Installation via container reduces this variability and allows for a smoother SRW App build experience.
8+
9+
The SRW Release v3 container includes the Intel runtime environment and the pre-built SRW App binaries.
810

911
The basic "out-of-the-box" case described in this User's Guide builds a weather forecast for June 15-16, 2019. Multiple convective weather events during these two days produced over 200 filtered storm reports. Severe weather was clustered in two areas: the Upper Midwest through the Ohio Valley and the Southern Great Plains. This forecast uses a predefined 25-km Continental United States (:term:`CONUS`) grid (RRFS_CONUS_25km), the Global Forecast System (:term:`GFS`) version 16 physics suite (FV3_GFS_v16 :term:`CCPP`), and :term:`FV3`-based GFS raw external model data for initialization.
1012

@@ -66,7 +68,7 @@ Build the Container
6668
Level 1 Systems
6769
^^^^^^^^^^^^^^^^^^
6870

69-
On most Level 1 systems, a container named ``ubuntu22.04-intel-ue-1.6.0-srw-dev.img`` has already been built at the following locations:
71+
On most Level 1 systems, a container named ``ubuntu22.04-intel-srw-release-public-v3.0.0-rt.img`` has already been built at the following locations:
7072

7173
.. list-table:: Locations of pre-built containers
7274
:widths: 20 50
@@ -98,20 +100,20 @@ Users can simply set an environment variable to point to the container:
98100

99101
.. code-block:: console
100102
101-
export img=/path/to/ubuntu22.04-intel-ue-1.6.0-srw-dev.img
103+
export img=/path/to/ubuntu22.04-intel-srw-release-public-v3.0.0-rt.img
102104
103105
Users may convert the container ``.img`` file to a writable sandbox:
104106

105107
.. code-block:: console
106108
107-
singularity build --sandbox ubuntu22.04-intel-ue-1.6.0-srw-dev $img
109+
singularity build --sandbox ubuntu22.04-intel-srw-release-public-v3.0.0-rt $img
108110
109111
When making a writable sandbox on Level 1 systems, the following warnings commonly appear and can be ignored:
110112

111113
.. code-block:: console
112114
113115
INFO: Starting build...
114-
INFO: Verifying bootstrap image ubuntu22.04-intel-ue-1.6.0-srw-dev.img
116+
INFO: Verifying bootstrap image ubuntu22.04-intel-srw-release-public-v3.0.0-rt.img
115117
WARNING: integrity: signature not found for object group 1
116118
WARNING: Bootstrap image could not be verified, but build will continue.
117119
@@ -124,22 +126,14 @@ On non-Level 1 systems, users should build the container in a writable sandbox:
124126

125127
.. code-block:: console
126128
127-
sudo singularity build --sandbox ubuntu22.04-intel-ue-1.6.0-srw-dev docker://noaaepic/ubuntu22.04-intel21.10-srw:ue160-fms202401-dev
128-
129-
Some users may prefer to issue the command without the ``sudo`` prefix. Whether ``sudo`` is required is system-dependent.
130-
131-
.. note::
132-
Users can choose to build a release version of the container using a similar command:
133-
134-
.. code-block:: console
135-
136-
sudo singularity build --sandbox ubuntu22.04-intel-srw-release-public-v3.0.0 docker://noaaepic/ubuntu22.04-intel21.10-srw:ue160-fms202401-release3
129+
singularity build --sandbox ubuntu22.04-intel-srw-release-public-v3.0.0-rt \
130+
docker://noaaepic/ubuntu22.04-intel2023.2.1-srw:ue160-fms202401-release3-rt
137131
138132
For easier reference, users can set an environment variable to point to the container:
139133

140134
.. code-block:: console
141135
142-
export img=/path/to/ubuntu22.04-intel-ue-1.6.0-srw-dev
136+
export img=/path/to/ubuntu22.04-intel-srw-release-public-v3.0.0-rt
143137
144138
.. _RunContainer:
145139

@@ -224,7 +218,7 @@ where:
224218
* ``-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``)
225219
* ``-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``)
226220
* ``<platform>`` refers to the local machine (e.g., ``hera``, ``jet``, ``noaacloud``). See ``MACHINE`` in :numref:`Section %s <user>` for a full list of options.
227-
* ``-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).
221+
* ``-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).
228222

229223
For example, on Hera, the command would be:
230224

0 commit comments

Comments
 (0)