Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Domains (DomainSpec/{grid}/Domain.yaml)

Current domains live in the catalog as one directory per grid, each holding a Domain.yaml. Example (cstar_forge/catalog/DomainSpec/wio-toy/Domain.yaml, the toy domain used in Getting Started):

Domain.yaml
description: "Western Indian Ocean (toy)"
model_name: "cson_roms-marbl_v0.1"
grid_name: "wio-toy"
start_time: "2012-01-01"
end_time: "2012-01-02"
grid_kwargs:
  nx: 20
  ny: 20
  size_x: 8000
  size_y: 8000
  center_lon: 60.0
  center_lat: -4.0
  rot: 0
  N: 10
open_boundaries:
  south: true
  east: true
  north: true
  west: true
partitioning:
  n_procs_x: 2
  n_procs_y: 5

Legacy nested-domain format

The pre-catalog notebook workflow described parent/child pairs in a single nested file; it is kept only as historical reference. Note that its _child_grid_name/_parent_grid_name keys are read by nothing today — the current nesting mechanism is a separately selected child DomainSpec feeding grid_kwargs_child/grid_kwargs_parent/metadata_child on build_forge_blueprint.

domains-nested.yaml
PAC_2fth_deg:
  description: "Pacific 2/15 deg (nested)"
  model_name: "cson_roms-marbl_v0.1"
  grid_name: "PAC_2fth_deg"
  start_time: "2012-01-01"
  end_time: "2012-01-02"
  grid_kwargs:
    nx: 208
    ny: 192
    size_x: 7300
    size_y: 11100
    center_lon: -165
    center_lat: 40
    rot: -90
    N: 10
    theta_s: 6.0
    theta_b: 3.0
    hc: 250.0
  open_boundaries:
    south: true
    east: false
    north: true
    west: true
  partitioning:
    n_procs_x: 16
    n_procs_y: 8
  _child_grid_name: "NEP-4th_deg"

NEP-4th_deg:
  description: "Northeast Pacific 1/4 deg (nested)"
  model_name: "cson_roms-marbl_v0.1"
  grid_name: "NEP-4th_deg"
  start_time: "2012-01-01"
  end_time: "2012-01-02"
  grid_kwargs:
    nx: 208
    ny: 192
    size_x: 4380
    size_y: 6660
    center_lon: -155
    center_lat: 42
    rot: -90
    N: 10
    theta_s: 6.0
    theta_b: 3.0
    hc: 250.0
    metadata:
      prefix: "child"
      period: 3600.0
      include_bgc: true
  open_boundaries:
    south: true
    east: false
    north: true
    west: true
  partitioning:
    n_procs_x: 16
    n_procs_y: 8
  _parent_grid_name: "PAC_2fth_deg"
  _child_grid_name: "GoA-10th_deg"

GoA-10th_deg:
  description: "Gulf of Alaska 1/10 deg (nested)"
  model_name: "cson_roms-marbl_v0.1"
  grid_name: "GoA-10th_deg"
  start_time: "2012-01-01"
  end_time: "2012-01-02"
  grid_kwargs:
    nx: 208
    ny: 192
    size_x: 1460
    size_y: 2220
    center_lon: -135
    center_lat: 52.6
    rot: -105
    N: 10
    theta_s: 6.0
    theta_b: 3.0
    hc: 250.0
    metadata:
      prefix: "child"
      period: 3600.0
      include_bgc: true
  open_boundaries:
    south: true
    east: false
    north: true
    west: true
  partitioning:
    n_procs_x: 16
    n_procs_y: 8
  _parent_grid_name: "NEP-4th_deg"