|
5 | 5 | [](https://www.repostatus.org/#active) |
6 | 6 | [](https://anaconda.org/conda-forge/regional-mom6) |
7 | 7 | [](https://badge.fury.io/py/regional-mom6) |
8 | | -[](https://joss.theoj.org/papers/d396435c09aae4c2f4b62cdbc1493c1e) |
9 | 8 | [](https://regional-mom6.readthedocs.io/en/latest/?badge=latest) |
10 | 9 |
|
11 | 10 | [](https://mit-license.org) |
12 | 11 | [](https://codecov.io/gh/COSIMA/regional-mom6) |
13 | 12 | [](https://github.com/psf/black) |
14 | 13 |
|
| 14 | +[](https://joss.theoj.org/papers/d396435c09aae4c2f4b62cdbc1493c1e) |
| 15 | + |
15 | 16 | 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! |
16 | 17 |
|
17 | 18 | The idea behind this package is that it should let 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 MOM6. Note that the resultant model configuration might still need some tweaking (e.g., fiddling with timestep to avoid CFL-related numerical stability issues or fiddling with bathymetry to deal with very narrow fjords or channels that may exist). |
@@ -129,3 +130,27 @@ the package using two different sets of input datasets. |
129 | 130 | Please ensure that you can get at least one of these working on your setup with your MOM6 executable before trying to modify the example to suit your domain with your bathymetry, forcing, and boundary conditions. |
130 | 131 |
|
131 | 132 | You can download the notebooks [from Github](https://github.com/COSIMA/regional-mom6/tree/main/demos) or by clicking on the download <img width="22" alt="download" src="https://github.com/COSIMA/regional-mom6/assets/7112768/2c1ae149-c6a8-4395-ab09-2f77588008d9"> button, e.g., at the top-right of the [regional Tasmania forced by ERA5 example](https://regional-mom6.readthedocs.io/en/latest/demo_notebooks/reanalysis-forced.html). |
| 133 | + |
| 134 | +## Citing |
| 135 | + |
| 136 | +If you use regional-mom6 in research, teaching, or other activities, we would be grateful |
| 137 | +if you could mention regional-mom6 and cite our paper in JOSS: |
| 138 | + |
| 139 | +> Barnes et al., (2024). regional-mom6: A Python package for automatic generation of regional configurations for the Modular Ocean Model 6. _Journal of Open Source Software_, **9(100)**, 6857, doi:[10.21105/joss.06857](https://doi.org/10.21105/joss.06857). |
| 140 | +
|
| 141 | +The bibtex entry for the paper is: |
| 142 | + |
| 143 | +```bibtex |
| 144 | +@article{regional-mom6-JOSS, |
| 145 | + doi = {10.21105/joss.06857}, |
| 146 | + url = {https://doi.org/10.21105/joss.06857}, |
| 147 | + year = {2024}, |
| 148 | + publisher = {The Open Journal}, |
| 149 | + volume = {9}, |
| 150 | + number = {100}, |
| 151 | + pages = {6857}, |
| 152 | + author = {Ashley J. Barnes and Navid C. Constantinou and Angus H. Gibson and Andrew E. Kiss and Chris Chapman and John Reily and Dhruv Bhagtani and Luwei Yang}, |
| 153 | + title = {{regional-mom6: A Python package for automatic generation of regional configurations for the Modular Ocean Model 6}}, |
| 154 | + journal = {Journal of Open Source Software} |
| 155 | +} |
| 156 | +``` |
0 commit comments