e3sm/init

add_tasks.add_e3sm_init_tasks(component)

Add all tasks to the e3sm/init component

Tasks

topo

combine

CombineStep(component, subdir[, low_res])

A step for combining global and antarctic topography datasets

CombineStep.get_subdir(low_res)

Get the subdirectory for the step based on the datasets :param low_res: Whether to use the low resolution configuration options :type low_res: bool, optional

CombineStep.setup()

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

CombineStep.constrain_resources(...)

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

CombineStep.run()

Run this step

CombineTask(component, low_res)

A task for creating the combined topography dataset, used to create the files to be cached for use in all other contexts

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.

RemapTopoStep(component, base_mesh_step, ...)

A step for remapping topography data such as base elevation and ice sheet properites from a cubed-sphere grid to a global MPAS base mesh.

RemapTopoStep.setup()

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

RemapTopoStep.constrain_resources(...)

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

RemapTopoStep.define_smoothing(ds_unsmoothed)

Define smoothing expand_distance and expand_factor fields.

RemapTopoStep.run()

Run this step of the test case

RemapTopoTask(component, base_mesh_step, ...)

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

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 cpus_per_task and ntasks based on the number of cores available to this step

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 cpus_per_task and ntasks based on the number of cores available to this step

CullMeshStep.run()

Run this step of the test case

CullTopoTask(component, base_mesh_step, ...)

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