From f0bc0690da420397a489abbed0ff317a8ff47b7d Mon Sep 17 00:00:00 2001 From: Etienne Tourigny <etienne.tourigny@bsc.es> Date: Tue, 30 Apr 2024 17:47:11 +0000 Subject: [PATCH 1/2] update documentation for refactored scripts location (https://git.smhi.se/ec-earth/ecearth4/-/issues/23) --- source/building/main.rst | 6 +++--- source/monitoring/main.rst | 2 +- source/running/main.rst | 10 +++++----- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/source/building/main.rst b/source/building/main.rst index 84cb3c7..b6e7eab 100644 --- a/source/building/main.rst +++ b/source/building/main.rst @@ -70,7 +70,7 @@ of course other names can be chosen. needed at the time when the environment is created. If the environment cannot be created correctly, a likely source of errors is the user - environment. Make sure to check the platform definition files (in ``sources/se/platforms``) + environment. Make sure to check the platform definition files (in ``scripts/platforms``) for information on loaded modules, etc. You can test if the environment is correctly set up by running ScriptEngine: @@ -123,7 +123,7 @@ The ScriptEngine scripts needed to built the components are located in the .. code-block:: shell - ecearth4> cd sources/se + ecearth4> cd scripts/build se> ls -1 platforms/ templates/ @@ -170,7 +170,7 @@ commands in one go: .. code-block:: shell - se> se user-settings.yml platforms/<MY_PLATFORM>.yml compile-<COMPONENT>.yml + se> se user-settings.yml ../platforms/<MY_PLATFORM>.yml compile-<COMPONENT>.yml .. note:: It is important to always include the user and platform settings scripts in every compilation! The settings are not magically stored between diff --git a/source/monitoring/main.rst b/source/monitoring/main.rst index 7079b05..7a2d148 100644 --- a/source/monitoring/main.rst +++ b/source/monitoring/main.rst @@ -35,7 +35,7 @@ Switching off monitoring and again on later during the experiment is not supported. The script that controls online monitoring is found in -``runtime/se/scriptlib/monitoring.yml``. +``scripts/runtime/scriptlib/monitoring.yml``. Monitoring metrics diff --git a/source/running/main.rst b/source/running/main.rst index 1195dff..8b9af25 100644 --- a/source/running/main.rst +++ b/source/running/main.rst @@ -18,11 +18,11 @@ Running simple experiments ``LD_LIBRARY_PATH``, as described in :ref:`completing-the-environment`. To prepare for a simple test experiment, we start from the ScriptEngine example -scripts provided in ``runtime/se`` and subdirectories: +scripts provided in ``scripts/runtime`` and subdirectories: .. code-block:: shell - ecearth4> cd runtime/se + ecearth4> cd scripts/runtime se> ls -1 scriptlib/ templates/ @@ -75,13 +75,13 @@ In order to make it easier to get started, examples are provided. To start with, the same platform configuration file that was used to build the model should be used for the runtime environment. Thus, the model can be started with (still assuming that the current working -directory is ``ecearth4/runtime/se``): +directory is ``ecearth4/scripts/runtime``): .. code-block:: shell se> se \ my-user-config.yml \ - ../../sources/se/platforms/my-platform-config.yml \ + ../platforms/my-platform-config.yml \ my-experiment-config.yml \ scriptlib/main.yml @@ -488,7 +488,7 @@ This launch option uses SLURM and a user-defined shell script template, which the user needs to specify using the configuration parameter ``job.launch.shell.script``. The shell script template that the parameter refers to must exist in the -``runtime/se/templates/launch`` folder. +``scripts/runtime/templates/launch`` folder. The ``slurm-shell`` launch option allows the user to create specific launch scripts for HPC platforms where other options do not work. -- GitLab From f4c1f1e5cffc0bb21c73f88dc9ff07642924657d Mon Sep 17 00:00:00 2001 From: Etienne Tourigny <etienne.tourigny@bsc.es> Date: Mon, 6 May 2024 17:03:35 +0200 Subject: [PATCH 2/2] minor update for refactored scripts location --- source/building/main.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/building/main.rst b/source/building/main.rst index b6e7eab..9881392 100644 --- a/source/building/main.rst +++ b/source/building/main.rst @@ -119,7 +119,7 @@ Runoff-mapper (``runoff-mapper``) and the AMIP-Forcing-reader (``amip-forcing``). The ScriptEngine scripts needed to built the components are located in the -``se`` subdirectory: +``scripts/build`` subdirectory: .. code-block:: shell -- GitLab