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.

Sign up for GitHub

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

update driver docs #1213

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

update driver docs #1213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 14 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,14 +71,13 @@ If no configuration file is specified, the default

The output will take up approximately 1GB of space, and the simulation will take around 10 minutes to run on a single CPU, or less time on multiple CPUs or GPU.

> Note: If you want to set the configuration file to something other than the default
Note: If you want to set the configuration file to something other than the default
while running the driver interactively, you'll need to
manually set the values for `parsed_args["config_file"]` and `parsed_args["job_id"]`.
manually set the value for `config_file`.

>For example, to use the configuration file found at `config/ci_configs/amip_default.yml`, you would use add the following lines in the `run_amip` driver:
For example, to use the configuration file found at `config/ci_configs/amip_default.yml`, you would use set `config_file` as follows in the `run_amip` driver:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For example, to use the configuration file found at `config/ci_configs/amip_default.yml`, you would use set `config_file` as follows in the `run_amip` driver:
For example, to use the configuration file found at `config/ci_configs/amip_default.yml`, you would set `config_file` as follows in the `run_amip` driver:

```
parsed_args["config_file"] = "config/ci_configs/amip_default.yml"
parsed_args["job_id"] = "amip_default"
config_file = "config/ci_configs/amip_default.yml"
```

### A Note about ClimaComms and MPI
Expand Down Expand Up @@ -150,3 +149,13 @@ module load common

For additional information about these clusters, including how to gain access for the first time,
see our slurm-buildkite wiki pages for [Central](https://github.com/CliMA/slurm-buildkite/wiki/Central) and [clima](https://github.com/CliMA/slurm-buildkite/wiki/clima).

# Running Slabplanet
The `run_amip.jl` driver contains two modes: the full AMIP mode and a Slabplanet mode, where all surfaces are thermal slabs. Since AMIP is not a closed system, the Slabplanet mode is useful for checking conservation properties of the coupling.

Running a Slabplanet simulation is the same as running an AMIP simulation, except for the specifics of the configuration file provided, so all information from the `Running AMIP` section will apply here too. Note that the default configuration used by `run_amip.jl` specifies an AMIP simulation, so a configuration file must be specified to run a Slabplanet simulation. This can be done as follows:
```julia
julia --project=experiments/ClimaEarth experiments/ClimaEarth/run_amip.jl --config_file config/ci_configs/slabplanet_default.yml --job_id slabplanet_default
```

To ensure that conservation is tracked throughout the experiment, the `energy_check` field of the configuration file must be set to true.
27 changes: 24 additions & 3 deletions experiments/ClimaEarth/run_amip.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,32 @@ are prescribed using time-interpolations between monthly observed data. We use s

For more information, see the PCMDI's specifications for [AMIP I](https://pcmdi.github.io/mips/amip/) and [AMIP II](https://pcmdi.github.io/mips/amip2/).

This driver contains two modes. The full `AMIP` mode and a `SlabPlanet` (all surfaces are thermal slabs) mode. Since `AMIP` is not a closed system, the
`SlabPlanet` mode is useful for checking conservation properties of the coupling.
## Running the AMIP configuration
To run a coupled simulation in the default AMIP configuration, run the
following command from the root directory of the repository:
```bash
julia --project=experiments/ClimaEarth experiments/ClimaEarth/run_amip.jl
```

## Configuration
You can also specify a custom configuration file to run the coupled simulation
in a different setup. The configuration file should be a TOML file that overwrites
the input fields specified in `experiments/ClimaEarth/cli_options.jl`.
A set of example configuration files can be found in the `config/ci_configs/` directory.

For example, to run the coupled simulation with a different configuration file:
```bash
julia --project=experiments/ClimaEarth experiments/ClimaEarth/run_amip.jl --config_file="path/to/config.toml"
```

To run the coupled simulation interactively with a different configuration file,
set the `config_file` variable in this script to be the path to that file.

For more details about running a coupled simulation, including how to run in a
Slabplanet configuration, please see our [README.md](https://github.com/CliMA/ClimaCoupler.jl/blob/main/README.md).
=#

# Load the necessary modules
# Load the necessary modules and code to run the coupled simulation
include("setup_run.jl")

# Get the configuration file from the command line (or manually set it here)
Expand Down
Loading