mom6-forge 0.0.5

MOM6 simple grid and bathymetry generator

mom6_forge

mom6_forge (formerly mom6_bathy) is a Python tool for generating MOM6 horizontal grids, vertical grids, bathymetry files, mapping, and other input files for use within the context of idealized and regional modeling.

Documentation: https://ncar.github.io/mom6_forge/

Installation

Git Clone

git clone https://github.com/NCAR/mom6_forge.git
cd mom6_forge
conda env create -f environment.yml
conda activate mom6_forge

Conda Forge

conda install -c conda-forge mom6_forge

PyPI (pip)

mom6_forge depends on ESMPy, which must be installed before mom6_forge because it is not available on PyPI. Install it via conda first, then install mom6_forge with pip:

conda install esmpy
pip install mom6_forge

Quick Start

See the tutorial notebooks in notebooks/ for guided examples:

1. Spherical Grid — Create a basic spherical grid
2. Equatorial Refinement — Add enhanced equatorial resolution
3. Custom Bathymetry — Generate bathymetry from topography data
4. Ingest Land Mask — Apply an external land mask
5. Modify Existing — Modify an existing grid/bathymetry
6. Demo Editors — Interactive bathymetry editing tools

Requirements

• Python >=3.11.10, <3.15
• See environment.yml for the full dependency list