Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Fleshed out the README a bit
  • Loading branch information
ashjbarnes authored Sep 4, 2023
1 parent 6fd32fb commit b991049
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,18 @@

[![Repo status](https://www.repostatus.org/badges/latest/active.svg?style=flat-square)](https://www.repostatus.org/#active) [![License](https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square)](https://mit-license.org) [![codecov](https://codecov.io/gh/COSIMA/regional-mom6/branch/master/graph/badge.svg?token=7OEZ1UZRY4)](https://codecov.io/gh/COSIMA/regional-mom6) [![Documentation Status](https://readthedocs.org/projects/regional-mom6/badge/?version=latest)](https://regional-mom6.readthedocs.io/en/latest/?badge=latest) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

Users just need to provide some information about where, when, and how big their domain is and also where raw input forcing files are.
The package sorts out all the boring details and creates a set of MOM6-friendly input files along with setup directories ready to go!
Users just need to provide some information about where, when, and how big their domain is and also where raw input forcing files are. The package sorts out all the boring details and creates a set of MOM6-friendly input files along with setup directories ready to go!

Although the resultant regional configuration will likely still need some tweaking, the idea behind this package is that the model should help the user sidestep some of the tricky issues with getting the model to run in the first place. This removes some of the steep learning curve for people new to working with the model.

This module package is very much a work in progress - for example there is currently only one horizontal grid type (equally spaced longitude and latitude) but we plan to add many more options in the future. This functionality should be easy to add given the modular desin of the package. If you find this package useful and would like to add more functionality, [we'd love for contributions!](https://regional-mom6.readthedocs.io/en/latest/contributing.html).

## What you need to get started
1. A cool idea for a new regional MOM6 domain
2. A working MOM6 executable on a machine of your choice.
3. A bathymetry file that at least covers your domain
4. 3D ocean forcing files *of any resolution* on your choice of A, B or C Arakawa grid
5. Surface forcing files (eg ERA or JRA reanalysis)

Check out the the [documentation](https://regional-mom6.readthedocs.io/en/latest/) and browse through the [demos](https://regional-mom6.readthedocs.io/en/latest/demos.html).

Expand Down Expand Up @@ -44,3 +54,8 @@ or
```bash
pip install git+https://github.com/COSIMA/regional-mom6.git@061b0ef80c7cbc04de0566df329c4ea472002f7e
```


## Getting started

The two example notebooks walk you through how to use the package on two different sets of input datasets. Make sure that you can get at least one of these working on your setup with your MOM6 executable, and then try to modify them to apply to your domain with your bathymethry / forcing / boundaries.

0 comments on commit b991049

Please sign in to comment.