Welcome to mom6_forge documentation!

mom6_forge is a Python tool to generate MOM6 horizontal grid and bathymetry files to be used within the “CESM Simpler Models” framework. Follow the links below to learn more about available tools.

Contents:

• Installation
  • Prerequisite
  • Instructions
• Quickstart Guide
  • Step 1: Import modules
  • Step 2: Create the horizontal grid
  • Step 3: Create the Vertical Grid
  • Step 4: Create Bathymetry
  • Step 5: Write Model Input Files
  • Step 6: Editing Grids and Bathymetry
  • Further steps
• Bathymetry Workflow
  • Resolution Diagnosis
  • Masking Methods
  • Depth Methods
  • Cleanup
  • Decision Flow
  • Channel Width Constraints
• Regridding & Mapping
  • ESMF Meshes
  • Runoff Mapping
  • Generating a Mapping File
  • Regridding a Dataset
  • Cressman Interpolation
  • Subsampling Statistics
• Notebooks
  • Spherical grid with an idealized bathymetry
  • Spherical grid with equatorial refinement
  • Spherical grid with custom bathymetry and ridges
  • Applying an existing land fraction
  • Modify existing MOM6 grid
  • Coarsen an existing MOM6 grid
  • Object Configurators in mom6_forge
  • Cressman Interpolation Deep Dive
• Glossary
• UI Widgets
  • Creators
  • Topo & TopoEditor Edits
  • Undo & Redo
  • How It Works
  • Topo Git Functionality and How to Use It
  • Nuances (Initialization, Naming, etc.)

Python API:

• mom6_forge
  • mom6_forge package

Contributing:

• Contributing
  • Running the Tests
  • Building the Documentation

Indices and tables

• Index

• Module Index

• Search Page