User Guide

User Guide#

The CrocoDash workflow has four steps. Each step maps onto one module of the package, so you can read the docs in the same order you’d actually run the code.

The workflow at a glance#

        flowchart LR
    S1["Step 1: Grids<br/>hgrid, topo, vgrid<br/>mom6_forge"]
    S2["Step 2: Case setup<br/>Case(...)<br/>visualCaseGen"]
    S3a["Step 3a: Configure forcings<br/>case.configure_forcings(...)<br/>forcing_configurations"]
    S3b["Step 3b: Process forcings<br/>case.process_forcings(...)<br/>extract_forcings"]

    S1 --> S2 --> S3a --> S3b

  1. Grids — build the horizontal grid, bathymetry, and vertical grid for your domain (using mom6_forge).

  2. Case setup — create a Case object that ties your grid to a CESM regional MOM6 case (using VisualCaseGen under the hood).

  3. Forcings. This step is split in two because the configuration is lightweight but the processing is HPC-scale.

    • 3a. Configure forcings — declare which forcings your case needs (tides, BGC, runoff, …) and validate the choices.

    • 3b. Process forcings — run the extraction, regridding, and formatting. Submittable as a standalone batch job.

Reference pages#

These are not part of the linear workflow but you’ll reach for them often:

  • Compsets & Inputs — available CESM compsets, and how to customize MOM6 parameters via user_nl_mom.

  • Datasets — which raw datasets CrocoDash can download, and how the raw_data_access registry works.

  • Additional resources — talks, videos, and external tutorials.

Workflow

Reference

Frequently needed info#

“How do I set up a regional MOM6 case?”#

Follow the four workflow pages in order, or see the Tutorials & Gallery for worked examples.

“What compset should I use?”#

See Compsets & Inputs for the aliases CrocoDash ships with.

“What forcing options does my compset require?”#

After you instantiate your Case, CrocoDash prints the required configurators. You can also query the registry directly — see Configure Forcings.

“What raw datasets are available?”#

See Datasets.

“How do I change a MOM6 input parameter?”#

See the user_nl_mom section of Compsets & Inputs.

“Where are the working examples?”#

CrocoGallery — notebooks and end-to-end demos.

Community & help#

Contents