From fac21fc973a8b37d38a7bfed9d8886e42c3afb08 Mon Sep 17 00:00:00 2001 From: Sean Bryan Date: Fri, 8 Sep 2023 23:13:51 +1000 Subject: [PATCH 1/2] Fix errors in documentation and code comments Fixes #131 --- benchcab/internal.py | 4 ++-- docs/user_guide/config_options.md | 2 +- docs/user_guide/index.md | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/benchcab/internal.py b/benchcab/internal.py index daf0de37..7512fcd9 100644 --- a/benchcab/internal.py +++ b/benchcab/internal.py @@ -141,7 +141,7 @@ # on modelevaluation.org MEORG_EXPERIMENTS = { # List of FLUXNET site ids associated with the 'Five site test' - # experiment (workspace: NRI Land testing), see: + # experiment (workspace: benchcab-evaluation), see: # https://modelevaluation.org/experiment/display/xNZx2hSvn4PMKAa9R "five-site-test": [ "AU-Tum", @@ -151,7 +151,7 @@ "US-Whs", ], # List of FLUXNET site ids associated with the 'Forty two site test' - # experiment (workspace: NRI Land testing), see: + # experiment (workspace: benchcab-evaluation), see: # https://modelevaluation.org/experiment/display/urTKSXEsojdvEPwdR "forty-two-site-test": [ "AU-Tum", diff --git a/docs/user_guide/config_options.md b/docs/user_guide/config_options.md index a80cd967..ba8f0ad7 100644 --- a/docs/user_guide/config_options.md +++ b/docs/user_guide/config_options.md @@ -155,7 +155,7 @@ realisations: [ ### `experiment` -: Type of experiment to run. Experiments are defined in the **NRI Land testing** workspace on [modelevaluation.org][meorg]. This key specifies the met forcing files used in the test suite. To choose from: +: Type of experiment to run. Experiments are defined in the **benchcab-evaluation** workspace on [modelevaluation.org][meorg]. This key specifies the met forcing files used in the test suite. To choose from: - [`forty-two-site-test`][forty-two-me]: to run simulations using 42 FLUXNET sites - [`five-site-test`][five-me]: to run simulations using 5 FLUXNET sites diff --git a/docs/user_guide/index.md b/docs/user_guide/index.md index 942890e4..78f74778 100644 --- a/docs/user_guide/index.md +++ b/docs/user_guide/index.md @@ -157,9 +157,9 @@ The following files and directories are created when `benchcab run` executes suc : directory that contains the log files, output files, and tasks for running CABLE. -`tasks` +`runs/fluxsite/tasks` -: CABLE runs are organised into tasks where a task consists of a branch (realisation), a meteorological forcing, and a science configuration. In the above directory structure, `` uses the following naming convention: +: directory that contains task directories. CABLE runs are organised into tasks where a task consists of a branch (realisation), a meteorological forcing, and a science configuration. In the above directory structure, `` uses the following naming convention: ``` _R_S From 41d1dc67102127f73470f9b0c9130c612e7f84df Mon Sep 17 00:00:00 2001 From: Sean Bryan <39685865+SeanBryan51@users.noreply.github.com> Date: Thu, 14 Sep 2023 13:47:47 +1000 Subject: [PATCH 2/2] Update docs/user_guide/index.md Co-authored-by: Claire Carouge --- docs/user_guide/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user_guide/index.md b/docs/user_guide/index.md index 78f74778..e61be51b 100644 --- a/docs/user_guide/index.md +++ b/docs/user_guide/index.md @@ -159,7 +159,7 @@ The following files and directories are created when `benchcab run` executes suc `runs/fluxsite/tasks` -: directory that contains task directories. CABLE runs are organised into tasks where a task consists of a branch (realisation), a meteorological forcing, and a science configuration. In the above directory structure, `` uses the following naming convention: +: directory that contains task directories. A task consists of a CABLE run for a branch (realisation), a meteorological forcing, and a science configuration. In the above directory structure, `` uses the following naming convention: ``` _R_S