polaris.tasks.e3sm.init.component_inputs.BaseMeshStep

class polaris.tasks.e3sm.init.component_inputs.BaseMeshStep(component, subdir, base_mesh_step, cull_mesh_step, with_maps, name='staged_base_mesh')[source]

A step for staging the base mesh with maps to the meshes culled from it.

The base mesh itself is unchanged; what this adds is the nine mapBaseTo{Ocean,OceanNoCavities,Land}{Cell,Edge,Vertex} fields, so that a consumer holding the base mesh – the MOAB coupler, which maps to and from it – can find each element on each culled mesh without a second file.

Variables:

base_mesh_step (polaris.mesh.spherical.SphericalBaseStep) – The step that built the base mesh.
cull_mesh_step (polaris.tasks.e3sm.init.topo.cull.CullMeshStep) – The step that culled it, and wrote the forward index maps.
with_maps (bool) – Whether the index maps are added.

__init__(component, subdir, base_mesh_step, cull_mesh_step, with_maps, name='staged_base_mesh')[source]

Create a new step.

Parameters:

component (polaris.Component) – The component the step belongs to.
subdir (str) – The subdirectory for the step.
base_mesh_step (polaris.mesh.spherical.SphericalBaseStep) – The step that built the base mesh.
cull_mesh_step (polaris.tasks.e3sm.init.topo.cull.CullMeshStep) – The step that culled it, and wrote the forward index maps.
with_maps (bool) – Whether to add the index maps. Only meshes that are actually culled have them to add.
name (str, optional) – The name of the step.

Methods

`__init__`(component, subdir, base_mesh_step, ...)	Create a new step.
`add_cf_check`([filename])	Check an output file for CF compliance after the step runs.
`add_dependency`(step[, name])	Add step as a dependency of this step (i.e. this step can't run until the dependency has finished).
`add_input_file`([filename, target, database, ...])	Add an input file to the step (but not necessarily to the MPAS model).
`add_output_file`(filename[, validate_vars, ...])	Add the output file to the step
`add_property_check`(filename, check_properties)	Add a single conservation comparison for an output file
`check_cf`()	Check the files added with `add_cf_check()` for CF compliance.
`check_properties`()	Check conservation properties of the output files of this step.
`constrain_resources`(available_resources)	Constrain `cpus_per_task` and `ntasks` based on the number of cores available to this step
`process_inputs_and_outputs`()	Process the inputs to and outputs from a step added with `polaris.Step.add_input_file()` and `polaris.Step.add_output_file()`.
`run`()	Add the base-to-culled index maps to the base mesh and write it out.
`runtime_setup`()	Update attributes of the step at runtime before calling the `run()` method.
`set_resources`([cpus_per_task, ...])	Update the resources for the subtask.
`set_shared_config`(config[, link])	Replace the step's config parser with the shared config parser
`setup`()	Link the base mesh, whose filename is a config option of the step that built it.
`validate_baselines`()	Compare variables between output files in this step and in the same step from a baseline run if one was provided.
`work_path`(*filenames)	Get the absolute path to a file or directory in the step's work directory

Attributes

`cores`	the number of cores this step needs, in total
`gpus`	the number of GPUs this step needs, in total
`may_span_nodes`	whether this step's cores and GPUs may come from several nodes
`min_cores`	the number of cores this step needs in order to run at all
`min_gpus`	the number of GPUs this step requires, in total
`output_filename`	The file this step writes.