From a8152e550b3464c07700b0c4074661b05dd82649 Mon Sep 17 00:00:00 2001 From: Frank Malatino <142349306+fmalatino@users.noreply.github.com> Date: Fri, 13 Dec 2024 11:19:08 -0500 Subject: [PATCH] Updated README to include directions for generating eta files (#99) * Updated README to include directions for generating eta files * Linting * Updated baroclinic_c2.yaml to generate zarr output --- README.md | 11 ++++++++++- examples/configs/baroclinic_c12.yaml | 4 ++-- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0086cf10..accd249f 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 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