mesh

add_mesh_tasks(component)

Add all tasks to the mesh component

Tasks

Base Mesh Tasks

add_base_mesh_tasks(component)

Add tasks for uniform spherical base meshes to the mesh component

BaseMeshTask(component, base_mesh_step)

A task for creating a uniform spherical mesh with a given resolution

Unified Coastline Tasks

CONVENTIONS

Built-in immutable sequence.

ComputeCoastlineStep(component, ...)

Prepare coastline masks and signed-distance fields on a lat-lon grid.

ComputeCoastlineStep.setup()

Set up the step in the work directory, including linking inputs.

ComputeCoastlineStep.run()

Run this step.

RemapCoastlineStep(component, ...)

Remap coastline products from the finest lat-lon grid to a coarser one.

RemapCoastlineStep.setup()

Set up the step in the work directory, including linking inputs.

RemapCoastlineStep.run()

Run this step.

build_coastline_datasets(ds_topo, resolution)

Build coastline datasets from combined topography.

build_coastline_dataset(ds_topo, resolution, ...)

Build a coastline dataset for one coastline convention.

get_unified_mesh_coastline_steps(resolution)

Get shared coastline-preparation steps for a lat-lon target grid.

LatLonCoastlineTask(component, resolution)

A task for preparing coastline products on a latitude-longitude grid.

add_coastline_tasks(component)

Add standalone coastline tasks for each supported lat-lon target grid.

VizCoastlineStep(component, coastline_step, ...)

A step for visualizing coastline diagnostics.

VizCoastlineStep.setup()

Set up the step in the work directory, including linking inputs.

VizCoastlineStep.run()

Run this step.

Unified River Tasks

SimplifyRiverNetworkStep(component, subdir)

Prepare a simplified, source-grid-independent river network.

SimplifyRiverNetworkStep.setup()

Add the HydroRIVERS shapefile archive input and declare outputs.

SimplifyRiverNetworkStep.run()

Download, unpack, convert, and simplify HydroRIVERS source data.

simplify_river_network_feature_collection(...)

Simplify a HydroRIVERS-style feature collection.

RasterizeRiverLatLonStep(component, ...)

Rasterize a simplified river network onto a shared lat-lon target grid.

RasterizeRiverLatLonStep.setup()

Link shared source and coastline inputs and declare outputs.

RasterizeRiverLatLonStep.run()

Build the target-grid river-channel mask.

build_river_network_dataset(...[, ...])

Rasterize a simplified river network onto a regular lat-lon grid.

ClipRiverNetworkStep(component, ...)

Prepare clipped river products for base-mesh consumers.

ClipRiverNetworkStep.setup()

Link simplified river and coastline products and declare outputs.

ClipRiverNetworkStep.run()

Clip and simplify the retained river network for base-mesh use.

get_unified_mesh_river_steps(mesh_name[, ...])

Get shared river-network steps for one mesh (source, lat-lon, base-mesh).

VizRiverStep(component, simplify_step, ...)

A step for visualizing river-network diagnostics.

VizRiverStep.setup()

Set up the step in the work directory, including linking inputs.

VizRiverStep.run()

Run this step.

UnifiedRiverNetworkTask(component, mesh_name)

A standalone task for preparing all river-network products for one mesh.

add_river_tasks(component)

Add standalone river-network tasks.

Unified Sizing-Field Tasks

BuildSizingFieldStep(component, ...)

Build a unified sizing field on a shared lat-lon target grid.

BuildSizingFieldStep.setup()

Link coastline and river products, configure the mesh family, and declare outputs.

BuildSizingFieldStep.run()

Build the sizing-field dataset and write it to NetCDF.

sizing_field_dataset(ds_coastline, ds_river, ...)

Build the unified sizing-field dataset from coastline and river products.

VizSizingFieldStep(component, sizing_step, ...)

Visualize sizing-field diagnostics produced by BuildSizingFieldStep.

VizSizingFieldStep.setup()

Link the sizing-field dataset and declare outputs.

VizSizingFieldStep.run()

Create simple global diagnostic plots and a text summary.

SizingFieldTask(component, mesh_name)

A standalone task for building one named unified sizing field.

add_sizing_field_tasks(component)

Add standalone sizing-field tasks for all supported unified meshes.

get_unified_mesh_sizing_field_steps(mesh_name)

Get shared sizing-field steps for one named mesh.

get_sizing_field_config(mesh_name[, filepath])

Load one unified mesh config with sizing-field defaults.

Unified Base-Mesh Tasks

BaseMeshTask(component, mesh_name)

A standalone task for creating one named unified base mesh.

VizBaseMeshStep(component, base_mesh_step, ...)

Visualize the final unified base mesh together with key inputs.

VizBaseMeshStep.setup()

Link the final mesh, sizing field and retained river geometry.

VizBaseMeshStep.run()

Create durable mesh, sizing-field and river-alignment diagnostics.

add_unified_base_mesh_tasks(component)

Add standalone base-mesh tasks for the supported unified meshes.

get_unified_base_mesh_steps(mesh_name[, ...])

Get shared steps for building one named unified base mesh.