From 8b993e67146cd790b04a9d440453d0a8237ca85c Mon Sep 17 00:00:00 2001 From: Stefan Poll Date: Mon, 13 Apr 2026 13:28:16 +0200 Subject: [PATCH 1/3] change header of quick-start --- doc/user_guide/usage_wfe/quick-start.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/doc/user_guide/usage_wfe/quick-start.md b/doc/user_guide/usage_wfe/quick-start.md index e6bcf76..f63d384 100644 --- a/doc/user_guide/usage_wfe/quick-start.md +++ b/doc/user_guide/usage_wfe/quick-start.md @@ -1,10 +1,12 @@ -# 0. Preamble +# Quickstart + +## 0. Preamble The TSMP2 workflow engine (WFE) is designed to support a wide range of simulation applications. To facilitate immediate usability, it is distributed with a default test case that enables users to operate the WFE without requiring additional configuration or data. A specific configration is called simulation experiment. Please go to Setup, Build and Run for much more information. -# 1. TSMP pan-european domain +## 1. TSMP pan-european domain -## 1.1 Description of the model experiment +### 1.1 Description of the model experiment The numerical experiment covers a pan-European area, according to the EUR-12 CORDEX domain. [EURO-CORDEX](https://euro-cordex.net) is the European branch of the international CORDEX initiative, which is a program sponsored by the World Climate Research Program (WCRP) to organize an internationally coordinated framework to produce improved regional climate change projections for all land regions worldwide. The respective horizontal grid has a horizontal grid size of 0.11°(∼12 km). @@ -14,7 +16,7 @@ ICON is forced within ERA-5 [Hersbach et al.(2020)](https://doi.org/10.1002/qj.3 In this section, we want to perform a 24-hour simulation using the fully coupled TSMP2 including ICON-eCLM-ParFlow coupled with the OASIS3-MCT coupler over the EURO-CORDEX domain with about 0.11° grid spacing. ICON is doing its calculations - as the name already suggests - on an icosahedral grid structure, whereas eCLM and ParFlow use a curvilinear grid. The TSMP2 system allows, similar to TSMP1, different grids between the components and uses resampling weights for the exchange of information between the components. -## 1.2 TSMP Experiment setup +### 1.2 TSMP Experiment setup First, open a terminal and let's prepare the environment for TSMP2 runs: @@ -26,7 +28,7 @@ jutil env activate -p PROJECTNAME echo $BUDGET_ACCOUNTS ``` -# 2. Download the experiment setup +## 2. Download the experiment setup Get the real test case files by running @@ -51,7 +53,7 @@ cd $TSMP2_WFE/dta wget -x -l 8 -nH --cut-dirs=4 -e robots=off --recursive --no-parent --reject="index.html*" https://datapub.fz-juelich.de/slts/tsmp_testcases/data/tsmp2_eur12-iic_wfe_iniforc/ ``` -## 2.1 Check the configuration files +### 2.1 Check the configuration files Have a look at the configuration files by running: @@ -63,7 +65,7 @@ vim expid.conf > :notepad_spiral: **NOTE**: Which model-combination is set? -## 2.2. Check TSMP2 binaries +### 2.2. Check TSMP2 binaries In case that you have prebuilt TSMP2 model binaries, we are going to set the path to the shared `TSMP2` folder: @@ -78,7 +80,7 @@ cd ${wfe_dir}/src/TSMP2 ./build_tsmp2.sh icon eclm parflow ``` -# 3. Running the simulation +## 3. Running the simulation First, we are going to set the path to the shared `TSMP2` folder that contains the prebuilt binaries: From ca3ae0af89c617f90087f3c4830616f2e98a8f95 Mon Sep 17 00:00:00 2001 From: Stefan Poll Date: Mon, 13 Apr 2026 13:40:44 +0200 Subject: [PATCH 2/3] add log information in docs --- doc/user_guide/usage_wfe/running.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/user_guide/usage_wfe/running.md b/doc/user_guide/usage_wfe/running.md index 3345c95..615acbb 100644 --- a/doc/user_guide/usage_wfe/running.md +++ b/doc/user_guide/usage_wfe/running.md @@ -31,6 +31,12 @@ Start simulation The `master.conf` file contains general configuration settings for the workflow engine. It is located in `ctl/master.conf`. +## logs + +During runtime, log files are initially written to the directory `$wfe_dir/ctl/logs/`. Upon successful completion of the workflow and execution of the clean-up phase, these logs are automatically relocated to `$wfe_dir/ctl/simres/MODELID_DATE/log/`, where they are archived together with the corresponding simulation results. + +If the simulation terminates prematurely (e.g., due to a crash) before the clean-up phase is reached, or if the clean-up step has been explicitly deactivated, the log files will remain in their original location at `$wfe_dir/ctl/logs/`. In such cases, users are required to manually move the log files to the appropriate results directory or alternativly remove them manually. + ### Main Settings #### MODEL_ID From 4e6a475a158da4d1d536735f89d9b70883c70d89 Mon Sep 17 00:00:00 2001 From: Stefan Poll Date: Mon, 13 Apr 2026 13:52:24 +0200 Subject: [PATCH 3/3] addition to log-paragraph --- doc/user_guide/usage_wfe/running.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/user_guide/usage_wfe/running.md b/doc/user_guide/usage_wfe/running.md index 615acbb..e95e475 100644 --- a/doc/user_guide/usage_wfe/running.md +++ b/doc/user_guide/usage_wfe/running.md @@ -33,9 +33,9 @@ workflow engine. It is located in `ctl/master.conf`. ## logs -During runtime, log files are initially written to the directory `$wfe_dir/ctl/logs/`. Upon successful completion of the workflow and execution of the clean-up phase, these logs are automatically relocated to `$wfe_dir/ctl/simres/MODELID_DATE/log/`, where they are archived together with the corresponding simulation results. +During runtime, job log files are initially written to the directory `$wfe_dir/ctl/logs/`. The log-file of the model compnents are written in the run-directory. Upon successful completion of the workflow and execution of the clean-up phase, these logs are automatically relocated to `$wfe_dir/ctl/simres/MODELID_DATE/log/`, where they are archived together with the corresponding simulation results. -If the simulation terminates prematurely (e.g., due to a crash) before the clean-up phase is reached, or if the clean-up step has been explicitly deactivated, the log files will remain in their original location at `$wfe_dir/ctl/logs/`. In such cases, users are required to manually move the log files to the appropriate results directory or alternativly remove them manually. +If the simulation terminates prematurely (e.g., due to a crash) before the clean-up phase is reached, or if the clean-up step has been explicitly deactivated, the job log files will remain in their original location at `$wfe_dir/ctl/logs/`. In such cases, users are required to manually move the log files to the appropriate results directory or alternativly remove them manually. ### Main Settings