Skip to content

Commit

Permalink
Updated README to include directions for generating eta files
Browse files Browse the repository at this point in the history
  • Loading branch information
fmalatino committed Dec 13, 2024
1 parent 6915fc3 commit 0fc9e8e
Showing 1 changed file with 10 additions and 1 deletion.
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

0 comments on commit 0fc9e8e

Please sign in to comment.