diff --git a/ICON-NWP/bacy.md b/ICON-NWP/bacy.md index 2a60d3486009e9e3642458b509cf5e243c3c40a7..78173768cf727d6a3110d678d123a55354def18d 100644 --- a/ICON-NWP/bacy.md +++ b/ICON-NWP/bacy.md @@ -1,7 +1,8 @@ -bacy (short for ***ba***sic ***cy***cling) is a collection of scripts that run assimilation +bacy (short for **ba**sic **cy**cling) is a collection of scripts that run assimilation cycles with ICON. It is modular in structure with each module performing steps like computing the dynamical model evolution (more), data assimilation (core), -surface, snow and sea surface analysis. +surface, snow and sea surface analysis. + # BACY_1.0 @@ -20,6 +21,7 @@ git clone git@gitlab.dkrz.de:dace/dace_bacy.git <my_bacy_name> cd <my_bacy_name>/modules ./copy_defaults.sh ~~~ +If you want to get access to the DKRZ-gitlab, someone at DWD or DKRZ needs to approve, maybe Martin Weissmann or Stefano Serafin can help you. ## How to use BACY_1.0? (Overview) @@ -38,7 +40,7 @@ cannot be run. Otherwise, the module can start its work and it uses its working directory `run`. The behaviour of a module can be controlled via its INPUT ARGUMENTS during the -<module> script call and via its PARAMETERS defined in the configuration file +`<module>` script call and via its PARAMETERS defined in the configuration file `<module>_conf.sh`. Parametes which are needed by more than one module are outsourced to the COMMON configuration file `common/bacy_conf.sh`. @@ -55,8 +57,8 @@ prep_<module> [-h] [-d] arg1 ... argn save_<module> [-h] [-d] arg1 ... argn ~~~ -The option [-h] gives you an explanation of the usage of the script and the -option [-d] calls the script in a dry-run, meaning that no jobs will be +The option `[-h]` gives you an explanation of the usage of the script and the +option `[-d]` calls the script in a dry-run, meaning that no jobs will be submitted. ### A cycle @@ -72,7 +74,7 @@ In summary: to start an experiment, the following steps are necessary. prep_cycle [-h] arg1 ... argn cycle [-h] [-d] arg1 ... argn -For the options [-h] and [-d] see the explanations above. +For the options `[-h]` and `[-d]` see the explanations above. ### Default files @@ -93,7 +95,7 @@ people can push to `bacy-dev` to keep this branch away from accidental or not quality proven commits. If you want to contribute to a NEW FEATURE for BACY_1.0, first of all create a -new branch <project>-<feature>-<team>, which you can setup as `remote` +new branch `<project>-<feature>-<team>`, which you can setup as `remote` to share results inside your team. During your development it is IMPORTANT to regularly pull from the `bacy-dev`