From 0fc9e8e756e68049f7a76b4bfbd362cd824e4151 Mon Sep 17 00:00:00 2001 From: Frank Malatino Date: Fri, 13 Dec 2024 08:39:59 -0500 Subject: [PATCH 1/3] Updated README to include directions for generating eta files --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0086cf10..3763fd0e 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,16 @@ Shell scripts to install Pace on specific machines such as Gaea can be found in ### Run -With the environment activated, you can run an example baroclinic test case with the following command: +Located in the directory `examples/configs/` there are several example configurations to exhibit the current functionality of Pace. We suggest a new user start with the `baroclinic_c12.yaml` configuration. + +Before starting any run, including unit tests, the user must ensure that the proper input files are available. For the `baroclinic_c12.yaml` configuration a script to generate these files and place them in the location referenced in the configuration file is available in the `examples/` directory; `generate_eta_files.py`. To generate the files use the following commands from the top level of the clone of Pace: + +```shell +mkdir tests/main/input +python3 examples/generate_eta_files.py +mv *eta*.nc tests/main/input +``` +These commands will generate the files necessary and place them in the `tests/main/input` directory. Once the files are generated the `baroclinic_c12.yaml` configuration can be used to generate a run: ```shell mpirun -n 6 python3 -m pace.run examples/configs/baroclinic_c12.yaml From bae9069365413c216498688a7cb8f660c6a51ea9 Mon Sep 17 00:00:00 2001 From: Frank Malatino Date: Fri, 13 Dec 2024 08:50:54 -0500 Subject: [PATCH 2/3] Linting --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3763fd0e..accd249f 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ Shell scripts to install Pace on specific machines such as Gaea can be found in ### Run -Located in the directory `examples/configs/` there are several example configurations to exhibit the current functionality of Pace. We suggest a new user start with the `baroclinic_c12.yaml` configuration. +Located in the directory `examples/configs/` there are several example configurations to exhibit the current functionality of Pace. We suggest a new user start with the `baroclinic_c12.yaml` configuration. Before starting any run, including unit tests, the user must ensure that the proper input files are available. For the `baroclinic_c12.yaml` configuration a script to generate these files and place them in the location referenced in the configuration file is available in the `examples/` directory; `generate_eta_files.py`. To generate the files use the following commands from the top level of the clone of Pace: From 218eb6ce7f52c566cd0939e480ce5aae99d2dfba Mon Sep 17 00:00:00 2001 From: Frank Malatino Date: Fri, 13 Dec 2024 10:04:18 -0500 Subject: [PATCH 3/3] Updated baroclinic_c2.yaml to generate zarr output --- examples/configs/baroclinic_c12.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/configs/baroclinic_c12.yaml b/examples/configs/baroclinic_c12.yaml index 2b0a2e3f..b26ff172 100644 --- a/examples/configs/baroclinic_c12.yaml +++ b/examples/configs/baroclinic_c12.yaml @@ -20,8 +20,8 @@ layout: - 1 - 1 diagnostics_config: - path: output - output_format: netcdf + path: output.zarr + output_format: zarr names: - u - v