Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
closes #87
  • Loading branch information
ashjbarnes authored Jan 18, 2024
1 parent 68646e4 commit ed1fe0f
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,10 @@ or
```bash
pip install git+https://github.com/COSIMA/regional-mom6.git@061b0ef80c7cbc04de0566df329c4ea472002f7e
```
## MOM6 Configuration and Version Requirements
While the underlying package should work for coupled or ocean only configurations, the premade files for the demos are written for a coupled MOM6-SIS2 configuration.

The current release of this package assumes the latest source code of all components needed to run MOM6 as of January 2024. Note that GFDL's `MOM6_examples` repository uses older versions of the Flexible Modelling System (FMS), coupler, SIS2 and other components, so using the source code from here will *not* necessarily work. [This repository]( https://github.com/ashjbarnes/setup-mom6-nci) contains scripts for compiling MOM6, and includes a folder `src` containing submodules linked to the correct versions known to work with this package and its demos.

## Getting started

Expand Down

0 comments on commit ed1fe0f

Please sign in to comment.