All submission forms are available at github.com/WCRP-CMIP/Essential-Model-Documentation/issues/new/choose.
You will need a free GitHub account to submit — create one here if you don't already have one.
EMD submission follows a four-stage process, working from the bottom of the structure upwards — grids first, then components, then the assembled model. If your grids and model families are already registered from a previous submission, you can start at Stage 3.
Success
Each stage must pass a successful review before you can use its IDs in the next stage. See What to Expect on Submission for a full walkthrough of the review process.
Click any box in the diagram to open the corresponding GitHub submission form.
Stage 1: Grid Cells *¶
Register the fundamental horizontal geometry your model computes on — the shape, resolution, and extent of a 2D tile. A regular 1° atmosphere grid and a tripolar ocean grid are each their own record.
You will need: grid type, resolution, number of cells, coordinate system.
Following review, you will receive: a grid cell ID (g###) used in Stage 2.
Stage 2: Computational Grids *¶
Horizontal grid form → | Vertical grid form →
Computational grids assemble grid cells into the complete domain a component actually runs on, including the Arakawa staggering arrangement. Vertical grids are registered separately as they vary independently of the horizontal.
You will need: grid cell ID(s) from Stage 1, staggering convention, vertical coordinate type and levels.
Following review, you will receive: a horizontal grid ID (h###) and a vertical grid ID (v###) used in Stage 3.
Model / Component Families (Optional)¶
Model families capture scientific lineage. There are two types, both submitted through the same form and distinguished by a family_type field.
- A component family groups versions of a single-domain code base — NEMO, ARPEGE-Climat, SURFEX. It is referenced by model components at Stage 3.
- An ESM family groups coupled model configurations across generations — HadGEM3, CNRM-CM, CESM. It is referenced by the final model record at Stage 4.
Register families before Stage 3 if they do not already exist.
Stage 3: Model Components *¶
Model components are specific versioned instances of a piece of model software — an atmosphere, ocean, sea-ice, or land-surface code at a specific version. Each component is bound to a horizontal and vertical grid, producing a fully-specified component configuration.
Pre-registered components appear in a dropdown at the top of the form. Select one to auto-populate fields, then modify as needed.
You will need: component name and version, grid IDs from Stage 2, component family ID if applicable.
Following review, you will receive: a component config ID (e.g., atmosphere_arpege-climat-v6-3_h100_v100) used in Stage 4.
Stage 4: Model (source_id) *¶
The model record assembles the complete system — listing every component configuration, declaring which earth system realms are active or prescribed, recording coupling relationships, and referencing the ESM family. This creates the official CMIP source_id.
You will need: component config IDs from Stage 3, ESM family ID, coupling topology, calendar type.
Following review, you will receive: a registered source_id.
After Submission¶
Submissions go through automated validation followed by community scientific review. Approved entries are added to the EMD registry and appear in form dropdowns within approximately 24 hours.
Track your submissions: My Issues
A grid finder is also in progress and will be added here in due course.
Quick Reference¶
| Stage | Form | You provide | You receive |
|---|---|---|---|
| 1 | Grid cells | Geometry, coordinates | g### |
| 2a | Horizontal grid | Grid cell IDs, staggering | h### |
| 2b | Vertical grid | Coordinate type, levels | v### |
| — | Model family | Institution, domains | Family ID |
| 3 | Model component | Component details, grid IDs | Config ID |
| 4 | Model | Config IDs, coupling | source_id |