Skip to content

Commit

Permalink
Add section on supported configurations
Browse files Browse the repository at this point in the history
  • Loading branch information
SeanBryan51 committed Dec 5, 2023
1 parent 66ff25f commit 2b06e58
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,20 @@

- checks out the model versions specified by the user
- builds the required executables
- runs each model version across N standard science configurations
- runs each model version across N standard science configurations for a variety of meteorological forcings
- performs bitwise comparison checks on model outputs across model versions

The user can then pipe the model outputs into a benchmark analysis via [modelevaluation.org][meorg] to assess model performance.

The full documentation is available at [benchcab.readthedocs.io][docs].

## Supported configurations

`benchcab` currently tests the following model configurations for CABLE:

- **Flux site simulations (offline)** - running CABLE forced with observed eddy covariance data at a single site
- **Global/regional simulations (offline)** - running CABLE forced with observational products over a region (global or regional)

## License

`benchcab` is distributed under [an Apache License v2.0][apache-license].
Expand Down

0 comments on commit 2b06e58

Please sign in to comment.