polaris.tasks.ocean.realistic_global.init.lat_lon_map.LatLonMapStep

class polaris.tasks.ocean.realistic_global.init.lat_lon_map.LatLonMapStep(component, name, subdir, source_step, source_target, source_filename, source_mesh_name, cull_mesh_step, mesh_name)

A step for building the bilinear mapping file from a global latitude-longitude source grid to the culled MPAS ocean mesh.

This is the MPI (mbtempest or ESMF) half of a remapping workflow; a serial step applies the resulting weights with ncremap. The task count is sized from the mesh’s estimated ocean cell count and the remap_cells_per_task and remap_min_cells_per_task options in the [realistic_global_init] config section.

Variables:

• source_step (polaris.Step) – The upstream step that produces the source dataset.

• source_target (str) – The name of the source dataset in the work directory of source_step.

• source_filename (str) – The name the source dataset is linked under in this step.

• source_mesh_name (str) – The name of the source grid, used to label the mapping file.

• cull_mesh_step (polaris.tasks.e3sm.init.topo.cull.cull.CullMeshStep) – The upstream cull-mesh step whose outputs describe the target MPAS mesh.

• mesh_name (str) – The name of the MPAS mesh, used to label the mapping file.

__init__(component, name, subdir, source_step, source_target, source_filename, source_mesh_name, cull_mesh_step, mesh_name)

Create the step.

Parameters:

• component (polaris.tasks.ocean.Ocean) – The ocean component the step belongs to.

• name (str) – The name of the step.

• subdir (str) – The subdirectory for the step.

• source_step (polaris.Step) – The step that produces the source dataset.

• source_target (str) – The name of the source dataset in the work directory of source_step.

• source_filename (str) – The name to link the source dataset under in this step.

• source_mesh_name (str) – The name of the source grid, used to label the mapping file.

• cull_mesh_step (polaris.tasks.e3sm.init.topo.cull.cull.CullMeshStep) – The step that produces the culled ocean mesh files.

• mesh_name (str) – Name label for the MPAS mesh (used in the remapping weight filename).

Methods

__init__(component, name, subdir, ...)	Create the 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)	Update ntasks from cell-count estimate before constraining.
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()	Set up the source and destination grids, then build the mapping file.
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()	Declare input files and compute ntasks from the estimated mesh size.
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