Skip to content

Commit 6c25295

Browse files
author
Natalie Perlin
committed
HSD container tests updated directions
1 parent c3e7016 commit 6c25295

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

doc/UsersGuide/source/HSDcontainer.rst

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -208,19 +208,25 @@ When making a writable sandbox on NOAA :term:`RDHPCS`, the following warnings co
208208
WARNING: integrity: signature not found for object group 1
209209
WARNING: Bootstrap image could not be verified, but build will continue.
210210
211+
When a sandbox container directory is created, update the ``$img`` environmental variable to reference that directory, for example: ``export img=/path/to/ubuntu22.04-intel-wm-dev-hsd-test``.
212+
211213
From within the ``$HSD`` directory, copy the ``stage-rt.sh`` script out of the container.
212214

213215
.. code-block:: console
214216
215217
singularity exec -H $PWD $img cp /opt/stage-rt.sh .
216218
217-
The ``stage-rt.sh`` script should now be in the ``$HSD`` directory. If for some reason, the previous command was unsuccessful, users may try a version of the following command instead:
219+
The ``stage-rt.sh`` script should now be in the ``$HSD`` directory. If the previous command did not work as expected, users can attempt an alternative version of the command:
218220

219221
.. code-block:: console
220222
221223
singularity exec -B /<local_base_dir>:/<container_dir> $img cp /opt/stage-rt.sh .
222224
223-
where ``<local_base_dir>`` and ``<container_dir>`` are replaced with a top-level directory on the local system and in the container, respectively. Additional directories can be bound by adding another ``-B /<local_base_dir>:/<container_dir>`` argument before the container location (``$img``). Note that if previous steps included a ``sudo`` command, ``sudo`` may be required in front of this command.
225+
In this command:
226+
* replace ``<local_base_dir>`` with a top-level directory on the local system
227+
* replace ``<container_dir>`` with the corresponding top-level directory inside the container
228+
229+
Users can bind additional directories by including another ``-B /<local_base_dir>:/<container_dir>`` option before the container location (``$img``). Note that if earlier steps included a ``sudo`` command, ``sudo`` may be required in front of this command as well.
224230

225231
.. note::
226232

@@ -273,12 +279,15 @@ To configure the experiment, users may need to update the ``default_vars.sh`` sc
273279
Module Modification
274280
--------------------
275281

276-
The machine configuration file is located at ``ufs-weather-model/tests-dev/machine_config/machine_singularity.config``. It assumes that Rocoto can be loaded via ``module load`` command from the host machine's initial state. If an additional path or module needs to be loaded, modify the ``machine_singularity.config`` to reflect those additions. For example, if the Rocoto package is found within the ``contrib`` module, add ``module load contrib`` before the ``module load rocoto`` statement in the machine configuration file.
282+
The machine configuration file can be found at ``ufs-weather-model/tests-dev/machine_config/machine_singularity.config``. It assumes that Rocoto can be loaded via ``module load`` command from the host machine's default environment. If an additional modules or paths are required, update the ``machine_singularity.config`` accordingly. For example, if the Rocoto module requres loading ``contrib`` module first, add ``module load contrib`` before the ``module load rocoto`` statement in the machine configuration file.
277283

278284
Host Machine Modifications
279285
---------------------------
280286

281-
Default variables for regression tests and HSD tests are set in the ``default_vars.sh`` script in the ``ufs-weather-model`` directory copied *from the container*. The individual test scripts (e.g., ``baroclinic_wave``, ``2020_CAPE``) override these variables where necessary. However, when running the HSD cases in a container, the tasks-per-node (TPN) variables in the singularity section need to be modified to reflect the user's host machine TPN configuration.
287+
Default variables for regression tests and HSD tests are set in the ``default_vars.sh`` script in the ``ufs-weather-model/tests`` directory copied *from the container*. When running the HSD cases in a container, you must update the tasks-per-node (TPN) variables in the Singularity section to match the TPN configuration of your host machine. The individual test scripts (e.g., ``baroclinic_wave``, ``2020_CAPE``) found under ``ufs-weather-model/tests-dev/test_cases/tests`` override variables set in the ``default_vars.sh`` where necessary.
288+
289+
You may need to adjust the batch job submission scripts to suit your host machine. The scripts ``compile_slurm.IN_singularity`` (for building) and ``fv3_slurm.IN_singularity`` (for running HSD tests) can be found in the ``ufs-weather-model/test_cases/expt_conf`` directory.
290+
282291

283292
Test Configuration
284293
--------------------

0 commit comments

Comments
 (0)