This guide outlines how to submit Essential Model Documentation (EMD) for your climate model.

Overview¶

EMD submission follows a 4-stage process. If your grids and model/component families are already registered from previous EMD submission, start at Stage 3 (highlighted below). Otherwise, begin at Stage 1.

Subsequent submissions become faster as more shared information is registered.

flowchart LR
    subgraph Stage1["**Stage 1**"]
        S1["Grid Cells"]
    end
    subgraph Stage2["**Stage 2**"]
        direction TB
        S2a["Horizontal Grid"]
        S2b["Vertical Grid"]
    end
    subgraph MF["**Model Family**"]
        direction TB
        ESM["Earth System Family"]
        CF["Component Family"]
    end
    subgraph Stage3["**Stage 3**"]
        S3["Model Component"]
    end
    subgraph Stage4["**Stage 4**"]
        S4["Model"]
    end
    S1 -->|g###| S2a
    S2a -->|h###| S3
    S2b -->|v###| S3
    S3 -->|config ID| S4
    ESM -.->|family-id| S4
    CF -.->|family-id| S3
    click S1 "https://github.com/WCRP-CMIP/Essential-Model-Documentation/issues/new?template=horizontal_grid_cell.yml" _blank
    click S2a "https://github.com/WCRP-CMIP/Essential-Model-Documentation/issues/new?template=horizontal_computational_grid.yml" _blank
    click S2b "https://github.com/WCRP-CMIP/Essential-Model-Documentation/issues/new?template=vertical_computational_grid.yml" _blank
    click S3 "https://github.com/WCRP-CMIP/Essential-Model-Documentation/issues/new?template=model_component.yml" _blank
    click S4 "https://github.com/WCRP-CMIP/Essential-Model-Documentation/issues/new?template=model.yml" _blank
    click ESM "https://github.com/WCRP-CMIP/Essential-Model-Documentation/issues/new?template=model_family.yml" _blank
    click CF "https://github.com/WCRP-CMIP/Essential-Model-Documentation/issues/new?template=model_family.yml" _blank
    style Stage1 stroke:#333,stroke-width:2px,fill:none
    style Stage2 stroke:#333,stroke-width:2px,fill:none
    style MF stroke:#333,stroke-width:2px,fill:none
    style Stage3 stroke:#0066cc,stroke-width:3px,fill:none
    style Stage4 stroke:#333,stroke-width:2px,fill:none

Click any box to open the corresponding form.

Stage 1: Grid Cells¶

Form: Grid Cells

Register the fundamental grid cell geometry and coordinate systems.

Output: Grid cell ID (g###) for use in Stage 2.

Stage 2: Computational Grids¶

Forms: Horizontal Grid | Vertical Grid

Link grids into computational grids with specified staggering arrangements.

Output: Horizontal grid ID (h###) and vertical grid ID (v###) for use in Stage 3.

Model Family (Optional)¶

Form: Model Family

Register a family of related models or components sharing common code. Two types:

• Earth System Family → referenced in Stage 4 (Model)
• Component Family → referenced in Stage 3 (Model Component)

Output: Family ID for linking related configurations.

Stage 3: Model Components¶

Form: Model Component

Register individual model components (atmosphere, ocean, land surface, etc.) with their grid configurations.

Output: Component config ID (e.g., ocean_nemo-v3-6_c101_v103) for use in Stage 4.

Stage 4: Model (source_id)¶

Form: Model

Register the complete model configuration — the final step. This creates the official CMIP source_id.

Input required: Component config IDs from Stage 3, coupling relationships, calendar types.

What Happens After Submission¶

1. Validation — Automated checks verify your submission
2. Review — Community scientific review for consistency
3. Registration — Approved entries are added to the EMD registry
4. Dropdown Updates — New entries appear in form dropdowns within ~24 hours

Track your submissions: My Issues

Quick Reference¶