Metadata-Version: 2.4
Name: mom6_forge
Version: 0.0.2
Summary: MOM6 simple grid and bathymetry generator
Home-page: https://github.com/NCAR/mom6_forge
Author: Alper Altuntas
Author-email: altuntas@ucar.edu
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11,<3.15
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: setuptools<82.1,>=69.0
Requires-Dist: numpy<2.5.0,>=1.26
Requires-Dist: xarray<2026.3.0,>=2023.12
Requires-Dist: matplotlib<3.11.0,>=3.9
Requires-Dist: scipy<1.18.0,>=1.11
Requires-Dist: netcdf4<1.8.0,>=1.6
Requires-Dist: jupyterlab<4.6.0,>=4.0
Requires-Dist: ipympl<0.11.0,>=0.9.4
Requires-Dist: ipywidgets<8.2.0,>=8.1.1
Requires-Dist: sphinx<9.2.0,>=8.1
Requires-Dist: sphinx_rtd_theme<3.2.0,>=3.0
Requires-Dist: black<26.4.0,>=24.1
Requires-Dist: pytest<9.1.0,>=8.0
Requires-Dist: pytest-cov<7.2.0,>=7.0
Requires-Dist: gitpython<3.2.0,>=3.1
Requires-Dist: cartopy<0.30,>=0.23
Requires-Dist: xesmf<1.0.0,>=0.8.10
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# 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

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

### Conda Forge

```bash
conda install -c conda-forge mom6_forge
```

### PyPI (pip)

`mom6_forge` depends on [ESMPy](https://earthsystemmodeling.org/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:

```bash
conda install esmpy
pip install mom6_forge
```

## Quick Start

See the tutorial notebooks in [`notebooks/`](notebooks/) for guided examples:

1. [Spherical Grid](notebooks/1_spherical_grid.ipynb) — Create a basic spherical grid
2. [Equatorial Refinement](notebooks/2_equatorial_res.ipynb) — Add enhanced equatorial resolution
3. [Custom Bathymetry](notebooks/3_custom_bathy.ipynb) — Generate bathymetry from topography data
4. [Ingest Land Mask](notebooks/4_ingest_landmask.ipynb) — Apply an external land mask
5. [Modify Existing](notebooks/5_modify_existing.ipynb) — Modify an existing grid/bathymetry
6. [Demo Editors](notebooks/6_demo_editors.ipynb) — Interactive bathymetry editing tools

## Requirements

- Python >=3.11.10, <3.15
- See [`environment.yml`](environment.yml) for the full dependency list
