e3sm/init
|
Add all tasks to the e3sm/init component |
Tasks
topo resolution constants
int([x]) -> integer int(x, base=10) -> integer |
|
int([x]) -> integer int(x, base=10) -> integer |
|
Convert a string or number to a floating-point number, if possible. |
|
int([x]) -> integer int(x, base=10) -> integer |
staging E3SM input files
|
A base step for materializing a staged tree of E3SM input files. |
Rebuild the staged tree from empty and stage the README. |
|
|
Link one product into the assembled tree at its E3SM-facing path. |
|
Link every partition the given step produced. |
The work directory of another step, found from this one's. |
|
A script symlinked into the step's work directory for copying the staged tree into an inputdata directory. |
|
|
A step for partitioning an MPAS graph into the core counts E3SM runs use. |
Take the number of partitions to build at once from the config. |
|
Take the number of partitions to build at once from the config. |
|
Partition |
|
The core counts to partition a mesh into, from the config's bounds. |
|
The directory an assembly step materializes, relative to its work directory. |
|
|
The stripped value of a config option, or |
|
The creation date the staged files are stamped with, as |
|
Set the creation date to today if it is not already set, and return it. |
|
The MPAS-Ocean directory for a grid. |
|
The MPAS-Seaice directory for a grid. |
|
Where the MPAS-Ocean initial condition for a grid is staged. |
|
Where the unpartitioned MPAS-Ocean graph is staged, beside its partitions. |
|
Where one MPAS-Ocean graph partition is staged. |
Where the MPAS-Seaice initial condition for a grid is staged. |
|
|
Where one MPAS-Seaice graph partition is staged. |
|
A fairly exhaustive list of core counts to partition a mesh into. |
|
The core counts from |
|
The number of cells a METIS graph file describes. |
|
Write the partition file for each core count, several at a time. |
|
A graph file to partition, and which of a mesh's cells it covers. |
|
The graph of a region's cells, keeping only the edges between them. |
|
Write a graph in the format |
topo
combine
|
A step for getting the global and Antarctic topography datasets ready to be remapped to the target grid of combined topography. |
Set up the step in the work directory, including downloading the datasets |
|
Run this step |
|
|
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. |
Set up the step in the work directory, including linking the tiles and SCRIP files and making the commands |
|
Constrain |
|
|
A step for combining global and antarctic topography datasets. |
Get the base subdirectory for the step based on the datasets. |
|
|
Get the step name based on the current datasets and target grid. |
Set up the step in the work directory, including linking the files from the steps that prepare the datasets and make the weights |
|
Run this step |
|
|
Get shared combined-topography steps for a cubed-sphere target grid. |
|
Get shared combined-topography steps for a latitude-longitude target grid. |
|
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 |
|
A task for creating combined topography on a cubed-sphere target grid. |
|
A task for creating combined topography on a latitude-longitude grid. |
|
A step for visualizing the combined topography dataset |
Set up the step in the work directory, including linking input files |
|
Run this step |
remap
|
A step to mask the global topograph dataset for ocean and land regions |
Set up the step in the work directory and set input files. |
|
Constrain |
|
Override in subclasses to return an ocean and a land mask array with the same shape as |
|
Run the step. |
|
|
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. |
Set up the step in the work directory, including linking input files |
|
Define smoothing |
|
Run this step of the test case |
|
|
A step for making the weights that remap topography from a cubed-sphere grid to a global MPAS base mesh. |
Set up the step in the work directory, including linking input files and making the command |
|
Constrain |
|
Launch nothing if the prepare step found no remapping to do |
|
|
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`. |
Set up the step in the work directory, including linking input files |
|
Run this step of the test case |
|
|
A task for remapping a topography dataset to a global MPAS mesh first without smoothing and then optionally with smoothing |
|
A step for plotting fields from a remapped topography dataset |
Run this step of the test case |
|
|
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 a task to remap topography for each supported base mesh |
cull
|
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. |
Set up the step in the work directory, including downloading any dependencies. |
|
Constrain the cores this step uses to the cores available to it |
|
Define transects along which land must be present (e.g. to block ocean flow). |
|
Define transects along which ocean must be present (e.g. to allow ocean flow). |
|
Refine the mask for culling land and (optionally) grounded ice from the ocean. |
|
Refine the mask for culling ocean from the land. |
|
Run this step of the test case |
|
|
A step for culling out land cells from the ocean/sea-ice mesh and ocean/sea-ice cells from the land mesh. |
Set up the step in the work directory, including downloading any dependencies. |
|
Constrain the cores this step uses to the cores available to it |
|
Run this step of the test case |
|
|
A task for culling a topography dataset to land and ocea regions (the latter both with and without ice-shelf cavities) |
|
Get shared steps for masking and culling topography for one base mesh. |
|
Add a task to remap topography for each supported base mesh |
Check that the cull masks describe a consistent set of domains. |
|
Check that no land-locked cells survive in either ocean domain. |
|
|
Check that no cell on a critical ocean passage was culled from the ocean. |
Check that removing the cells in which sea ice would be trapped did not remove a whole sea from the ocean. |
|
Check that |
|
Check that the shortest |
|
|
Find the dead ends of a candidate ocean domain: the cells that the C-grid criterion removes, either because they have fewer than two active edges or because removing their neighbors leaves them so. |
|
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. |
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. |
component_inputs
|
A step for staging the base mesh with maps to the meshes culled from it. |
The file this step writes. |
|
Link the base mesh, whose filename is a config option of the step that built it. |
|
Add the base-to-culled index maps to the base mesh and write it out. |
|
|
A step for staging the SCRIP descriptions of the culled meshes. |
|
The file this step writes for one culled-mesh region. |
Resolve the E3SM short name, so that a mesh with none assigned fails here rather than after the workflow has run. |
|
Restamp each SCRIP file with the E3SM mesh name. |
|
|
A step for materializing the staged tree of component input files. |
Build the staged tree, from empty. |
|
|
A task for staging the E3SM component input files for one mesh. |
Fill in the creation date so it lands in the work directory's config. |
|
|
Get shared steps for staging E3SM component input files for one mesh. |
|
Add a task per unified mesh for staging E3SM component input files. |
ocean products
|
A step for staging the MPAS-Ocean mesh file. |
Refuse a model whose packaging is not supported, before anything runs. |
|
Combine the horizontal mesh and the vertical coordinate. |
|
The vertical-coordinate fields the staged mesh carries, all of which the initial-state step already writes. |
|
A step for staging the MPAS-Ocean initial condition. |
|
Refuse a model whose packaging is not supported, before anything runs. |
|
Stage the adjusted restart as the initial condition. |
|
A step for partitioning the ocean graph into the core counts E3SM runs use. |
|
Refuse a model whose packaging is not supported, before anything runs. |
|
Partition |
|
|
A step for the MOC basin masks and southern-boundary transects that MPAS-Ocean reads at run time. |
Set up the step, failing early for a model that cannot be packaged. |
|
Run the feature-mask step. |
|
the full ocean domain, matching what the ocean initial condition is built from. |
sea-ice products
|
A step for staging the MPAS-Seaice mesh file. |
Set up the task in the work directory, including downloading any dependencies. |
|
Stage the culled mesh as the sea-ice mesh. |
|
A step for staging the MPAS-Seaice initial condition. |
|
Set up the task in the work directory, including downloading any dependencies. |
|
Add the Coriolis parameter to the culled mesh. |
|
A step for building the bilinear mapping file from the QU60km sea-ice climatology to the sea-ice mesh. |
|
Resolve what the mapping file is named after, before anything runs. |
|
Set up the source and destination grids, then the command that builds the QU60km-to-mesh mapping file. |
|
A step for partitioning the sea-ice mesh. |
|
Take the number of partitions to build at once from the config. |
|
Weight the mesh by the sea-ice climatology, then partition it. |
leaf modules
|
The E3SM short name of the mesh the files are staged for. |
|
E3SM's name for the ocean and sea-ice grid of a mesh. |
|
Where the base mesh, carrying the base-to-culled index maps, is staged. |
|
Where the SCRIP description of one culled mesh is staged. |
|
Where a SCRIP description is staged beside the ocean products. |
|
Where one culled mesh is staged. |
|
Where the MOC basin masks and southern-boundary transects are staged. |
Invert one culled mesh's forward map into base-to-culled index fields. |
|
All nine base-to-culled index maps, one per culled mesh and element type. |
|
The ocean model the dynamic adjustment runs, if its files can be staged. |