diff --git a/Readme.md b/Readme.md index e63afb0..8223d3a 100644 --- a/Readme.md +++ b/Readme.md @@ -17,6 +17,36 @@ Further information is available at https://sven-karsten.github.io/iow_esm/intro # Versions +## 1.04.00 (in preparation) + +| date | author(s) | link | +|--- |--- |--- | +| 2022-12-22 | SK | [1.04.00](https://git.io-warnemuende.de/iow_esm/main/src/branch/1.04.00) | + +
+ +### changes +* several instqances of the IOW ESM can now run the same root folder + * this can be done by creating subfolders in the `input` folder + * the names of these input folder are then used as `run_name` +* output can be automatically archived and compressed (additinally monthly means are provided for fast access) +* output can automatically synchronized to a target while the model is running + +### dependencies +* bash, git, (python for GUI) + +### known issues +* none + +### tested with +* intensively tested on both HLRN machines + * using example setups available under: + (coupled, uncoupled MOM5, uncoupled CCLM, int2lm) /scratch/usr/mviowmod/IOW_ESM/setups/example/1.00.00 + * can be built and run on Haumea but output is not intensively tested + +
+ + ## 1.03.00 (latest release) | date | author(s) | link | @@ -389,9 +419,10 @@ Be sure that the remote computer knows your targets and can copy files to them. #### Available setups ##### HLRN in Göttingen -You can find an example setup for a MOM5 for the Baltic sea coupled to a CCLM model for the Eurocordex domain under `/scratch/usr/mviowmod/IOW_ESM/setups/MOM5_Baltic-CCLM_Eurocordex/example_8nm_0.22deg/1.00.00`. +You can find an example setup for a MOM5 (3 nm horizontal resolution) for the Baltic sea coupled to a CCLM model for the Eurocordex domain (0.22° horizontal resolution) under `/scratch/usr/mviowmod/IOW_ESM/setups/example/1.00.00`. +Here are also examples for uncoupled runs. The corresponding line in the `SETUPS` file could then look like -`coupled_example user@glogin:/scratch/usr/mviowmod/IOW_ESM/setups/MOM5_Baltic-CCLM_Eurocordex/example_8nm_0.22deg/1.00.00`, +`example user@glogin:/scratch/usr/mviowmod/IOW_ESM/setups/example/1.00.00`, where `user` should be replaced by your user name on the HLRN in Göttingen. It might be also necessary to add the full domain to the hostname, depending on your ssh configuration. Other example setups (also for uncoupled runs) can be found in `SETUPS.example` in this directory. @@ -404,11 +435,11 @@ Other example setups (also for uncoupled runs) can be found in `SETUPS.example` After creating the file `SETUPS` you can run in the root directory ``` bash -./deploy_setup.sh hlrng coupled_example +./deploy_setup.sh hlrng example ``` Before running the model you should have a look at the deployed folders on your target. -Especially you should go to the `input` folder and open the file `global_settings.py`. +Especially you should go to the folder `input/coupled` and open the file `global_settings.py`. Please enter your name and email here. Moreover you should have a look at the file `jobscript_*`. Here you may adjust the account which you will use for running the model. @@ -420,15 +451,24 @@ More details on the preparation of the `input` folder is given in the file `docu If everything is set up on your remote computer of choice, you can run the model for the first time by executing this in the root directory: ``` bash -./run.sh hlrng +./run.sh hlrng prepare-before-run coupled ``` The first argument of the run script is always the target keyword as specified in your `DESTINATIONS` file. By executing the run script all files from `scripts` directory will be transferred to the target. -After the scripts are transferred the model is started on the target. +The second argument stands for creating necessary mappinng files that are used for the coupling, see `documentation/developers_documentation.pdf`. +If these mapping files already exist or you want to start an uncoupled run, this argument can be left out + +The third argument corresponds to the name of input subfolder that you want to run. +If you want to run from several input folders, you can list all of them here. +If you just have a single input folder witout subfolders, this argument can be left out. + +In general the run command can look like + +``` bash +./run.sh prepare-before-run sync_to= input1 input2 input3 ... +``` +where destination1 corresponds to the run target machine and destination2 to a target, where you want to transfer the output to. -If you use one of the setups from the `SETUPS.example` file, there is no need for further preparation of the coupled model. -However for the general case there is the possibility to run preparation scripts that set up the exchange grid -and remapping files for the coupler, see `documentation/developers_documentation.pdf`. -Note that for an uncoupled run there is no need for the preparation. \ No newline at end of file +After all the scripts are transferred from your local computer to the target machine, the model is started on the target. \ No newline at end of file diff --git a/SETUPS.example b/SETUPS.example index e1a4fe0..92afb39 100644 --- a/SETUPS.example +++ b/SETUPS.example @@ -1,5 +1 @@ -coupled_example mvkkarst@glogin:/scratch/usr/mviowmod/IOW_ESM/setups/MOM5_Baltic-CCLM_Eurocordex/example_3nm_0.22deg/1.00.00 -CCLM_example mvkkarst@glogin:/scratch/usr/mviowmod/IOW_ESM/setups/CCLM_Eurocordex/example_0.22deg/1.00.00 -MOM5_example mvkkarst@glogin:/scratch/usr/mviowmod/IOW_ESM/setups/MOM5_Baltic/example_3nm/1.00.00 -I2LM_example mvkkarst@glogin:/scratch/usr/mviowmod/IOW_ESM/setups/I2LM_Eurocordex/example_ERAI_0.22deg/1.00.00 -update ./local_setup +example mvkkarst@glogin:/scratch/usr/mviowmod/IOW_ESM/setups/example/1.00.00 diff --git a/documentation/jupyterbook/usage/advanced_use.md b/documentation/jupyterbook/usage/advanced_use.md index 762ef98..8aafc85 100644 --- a/documentation/jupyterbook/usage/advanced_use.md +++ b/documentation/jupyterbook/usage/advanced_use.md @@ -45,6 +45,7 @@ That way, you can always identify with which version of the code your working on (usage:advanced_use:running_during_development)= ## Running during development +TODO: change this section to use of several input folders. ### Update the setup before running