Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README to include directions for generating eta files #99

Merged
merged 3 commits into from
Dec 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions examples/configs/baroclinic_c12.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ layout:
- 1
- 1
diagnostics_config:
path: output
output_format: netcdf
path: output.zarr
output_format: zarr
names:
- u
- v
Expand Down
Loading