e3sm/init

add_tasks.add_e3sm_init_tasks(component)

Add all tasks to the e3sm/init component

Tasks

topo resolution constants

STANDARD_CUBED_SPHERE_RESOLUTION

int([x]) -> integer int(x, base=10) -> integer

LOW_RES_CUBED_SPHERE_RESOLUTION

int([x]) -> integer int(x, base=10) -> integer

LOW_RES_BASE_MESH_CELL_WIDTH

Convert a string or number to a floating-point number, if possible.

LAT_LON_RESOLUTION_DECIMALS

int([x]) -> integer int(x, base=10) -> integer

topo shared utilities

CUBED_SPHERE_RESOLUTIONS

Built-in immutable sequence.

LAT_LON_RESOLUTIONS

Built-in immutable sequence.

format_lat_lon_resolution_name(resolution)

Format a latitude-longitude resolution for use in task subdirectories.

get_cubed_sphere_resolution(low_res)

Get the cubed-sphere source-topography resolution for a mode.

uses_low_res_cubed_sphere(cell_width)

Determine whether a base mesh should use lower-resolution topography.

topo

combine

PrepareCombineStep(component, subdir, name)

A step for getting the global and Antarctic topography datasets ready to be remapped to the target grid of combined topography.

PrepareCombineStep.setup()

Set up the step in the work directory, including downloading the datasets

PrepareCombineStep.run()

Run this step

CombineWeightsStep(component, subdir, name, ...)

A step for making the weights that remap each tile of the global dataset and the Antarctic dataset to the target grid of combined topography.

CombineWeightsStep.setup()

Set up the step in the work directory, including linking the tiles and SCRIP files and making the commands

CombineWeightsStep.constrain_resources(...)

Constrain cpus_per_task and ntasks based on the number of cores available to this step

CombineStep(component, subdir, target_grid, ...)

A step for combining global and antarctic topography datasets.

CombineStep.get_subdir()

Get the base subdirectory for the step based on the datasets.

CombineStep.get_name(target_grid, ...)

Get the step name based on the current datasets and target grid.

CombineStep.setup()

Set up the step in the work directory, including linking the files from the steps that prepare the datasets and make the weights

CombineStep.run()

Run this step

get_cubed_sphere_topo_steps(component, ...)

Get shared combined-topography steps for a cubed-sphere target grid.

get_lat_lon_topo_steps(component, resolution)

Get shared combined-topography steps for a latitude-longitude target grid.

get_combine_topo_symlinks(combine_step, key)

Get a combine topo step and the steps that prepare for it and make its weights, keyed by symlinks for a task that names the combine step key.

CubedSphereCombineTask(component, resolution)

A task for creating combined topography on a cubed-sphere target grid.

LatLonCombineTask(component, resolution)

A task for creating combined topography on a latitude-longitude grid.

VizCombinedStep(component, combine_step, subdir)

A step for visualizing the combined topography dataset

VizCombinedStep.setup()

Set up the step in the work directory, including linking input files

VizCombinedStep.run()

Run this step

remap

MaskTopoStep(component, combine_topo_step, ...)

A step to mask the global topograph dataset for ocean and land regions

MaskTopoStep.setup()

Set up the step in the work directory and set input files.

MaskTopoStep.constrain_resources(...)

Constrain cpus_per_task and ntasks based on the number of cores available to this step

MaskTopoStep.define_masks(ds)

Override in subclasses to return an ocean and a land mask array with the same shape as ds.base_elevation and other topogrpahy fields.

MaskTopoStep.run()

Run the step.

PrepareRemapTopoStep(component, ...[, ...])

A step for deciding how to smooth topography remapped to a global MPAS base mesh and making the SCRIP file for the mesh, expanded to smooth.

PrepareRemapTopoStep.setup()

Set up the step in the work directory, including linking input files

PrepareRemapTopoStep.define_smoothing(...)

Define smoothing expand_distance and expand_factor fields.

PrepareRemapTopoStep.run()

Run this step of the test case

RemapTopoWeightsStep(component, ...)

A step for making the weights that remap topography from a cubed-sphere grid to a global MPAS base mesh.

RemapTopoWeightsStep.setup()

Set up the step in the work directory, including linking input files and making the command

RemapTopoWeightsStep.constrain_resources(...)

Constrain cpus_per_task and ntasks based on the number of cores available to this step

RemapTopoWeightsStep.runtime_setup()

Launch nothing if the prepare step found no remapping to do

RemapTopoStep(component, base_mesh_step, ...)

A step for remapping topography data such as base elevation and ice sheet properties from a cubed-sphere grid to a global MPAS base mesh, using the weights from {py:class}`polaris.tasks.e3sm.init.topo.remap.RemapTopoWeightsStep`.

RemapTopoStep.setup()

Set up the step in the work directory, including linking input files

RemapTopoStep.run()

Run this step of the test case

RemapTopoTask(component, mesh_name[, ...])

A task for remapping a topography dataset to a global MPAS mesh first without smoothing and then optionally with smoothing

VizRemappedTopoStep(component, name, subdir, ...)

A step for plotting fields from a remapped topography dataset

VizRemappedTopoStep.run()

Run this step of the test case

get_remap_topo_steps(mesh_name[, smoothing, ...])

Get shared steps for computing a mapping file and then remapping bathymetry and ice-shelf topography from a cubed-sphere grid to a global MPAS base mesh.

add_remap_topo_tasks(component)

Add a task to remap topography for each supported base mesh

cull

CullMaskStep(component, base_mesh_step, ...)

A step for creating the masks that will be used to cull land and ocean/sea-ice meshes based on critical land and ocean/sea-ice transects, handling land-locked cells, and flood-filling to make sure that Antarctic land ice and ocean are both contiguous.

CullMaskStep.setup()

Set up the step in the work directory, including downloading any dependencies.

CullMaskStep.constrain_resources(...)

Constrain the cores this step uses to the cores available to it

CullMaskStep.define_critical_land_transects(gf)

Define transects along which land must be present (e.g. to block ocean flow).

CullMaskStep.define_critical_ocean_transects(gf)

Define transects along which ocean must be present (e.g. to allow ocean flow).

CullMaskStep.refine_ocean_cull_mask(...)

Refine the mask for culling land and (optionally) grounded ice from the ocean.

CullMaskStep.refine_land_cull_mask(...)

Refine the mask for culling ocean from the land.

CullMaskStep.run()

Run this step of the test case

CullMeshStep(component, base_mesh_step, ...)

A step for culling out land cells from the ocean/sea-ice mesh and ocean/sea-ice cells from the land mesh.

CullMeshStep.setup()

Set up the step in the work directory, including downloading any dependencies.

CullMeshStep.constrain_resources(...)

Constrain the cores this step uses to the cores available to it

CullMeshStep.run()

Run this step of the test case

CullTopoTask(component, mesh_name[, include_viz])

A task for culling a topography dataset to land and ocea regions (the latter both with and without ice-shelf cavities)

get_cull_topo_steps(mesh_name[, include_viz])

Get shared steps for masking and culling topography for one base mesh.

add_cull_topo_tasks(component)

Add a task to remap topography for each supported base mesh

consistency.check_cull_mask_consistency(...)

Check that the cull masks describe a consistent set of domains.

consistency.check_land_locked_criteria(...)

Check that no land-locked cells survive in either ocean domain.

consistency.check_critical_passages(...[, ...])

Check that no cell on a critical ocean passage was culled from the ocean.

dc_edge_diagnostics.check_ocean_dc_edge(...)

Check that dcEdge in the ocean/sea-ice domain stays within bounds relative to the local ocean background cell width.

land_locked.remove_land_locked_cells(...[, ...])

Refine the ocean and ocean-without-cavities domains together, removing the cells in which the ocean cannot circulate and those in which sea ice would be trapped.

land_locked.remove_ocean_land_locked_cells(...)

Refine the ocean domain alone, removing the cells through which a C-grid cannot circulate and those that are not connected to the open ocean.