Merge branch 'main' into joss-paper

README.md

@@ -1,13 +1,15 @@
 # regional-mom6
 
-*Python package for automatic generation of regional configurations for the [Modular Ocean Model version 6](https://github.com/mom-ocean/MOM6) (MOM6).*
+*Python package for automatic generation of regional configurations for the [Modular Ocean Model version 6](https://github.com/mom-ocean/MOM6) (MOM6)*
 
 [![Repo status](https://www.repostatus.org/badges/latest/active.svg?style=flat-square)](https://www.repostatus.org/#active)
 [![conda forge](https://img.shields.io/conda/vn/conda-forge/regional-mom6.svg)](https://anaconda.org/conda-forge/regional-mom6)
 [![pypi](https://badge.fury.io/py/regional-mom6.svg)](https://badge.fury.io/py/regional-mom6)
+[![status](https://joss.theoj.org/papers/d396435c09aae4c2f4b62cdbc1493c1e/status.svg)](https://joss.theoj.org/papers/d396435c09aae4c2f4b62cdbc1493c1e)
+[![Documentation Status](https://readthedocs.org/projects/regional-mom6/badge/?version=latest)](https://regional-mom6.readthedocs.io/en/latest/?badge=latest)
+
 [![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/main/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! 

docs/conf.py

@@ -1,9 +1,9 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = "Regional MOM6"
-copyright = "2023, Ashley Barnes & COSIMA Contributors"
-author = "Ashley Barnes & COSIMA Contributors"
+project = "regional-mom6"
+copyright = "2024, COSIMA community and outside contributors"
+author = "COSIMA community and outside contributors"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

docs/index.rst

@@ -1,7 +1,7 @@
 Regional MOM6 Documentation
 ===========================
 
-[regional-mom6](https://github.com/COSIMA/regional-mom6/) is a Python package for automatic generation of regional configurations for the `Modular Ocean Model version 6`_ (MOM6).
+`regional-mom6`_ is a Python package for automatic generation of regional configurations for the `Modular Ocean Model version 6`_ (MOM6).
 
 In brief...
 -----------
@@ -53,7 +53,7 @@ What you need to get started
 
 Browse through the `demos <demos.html>`_.
 
-
+.. _regional-mom6: https://github.com/COSIMA/regional-mom6
 .. _Modular Ocean Model version 6: https://github.com/mom-ocean/MOM6
 .. _open a pull request: https://github.com/COSIMA/regional-mom6/pulls
 

pyproject.toml

@@ -1,9 +1,9 @@
 [project]
 name = "regional_mom6"
-description = "Automatic generation of regional configurations for Modular Ocean Model 6"
-keywords = ["mom6", "regional", "ocean modeling"]
+description = "Automatic generation of regional configurations for Modular Ocean Model v6"
+keywords = ["mom6", "regional", "ocean modeling", "python"]
 authors = [
-  {name = "Ashley Barnes, COSIMA community, and contributors"},
+  {name = "COSIMA community and outside contributors"},
 ]
 dynamic = ["version"]
 readme = "README.md"