polaris.tasks.e3sm.init.component_inputs.ocean_graph_partition.OceanGraphPartitionStep

class polaris.tasks.e3sm.init.component_inputs.ocean_graph_partition.OceanGraphPartitionStep(component, subdir, cull_mesh_step, name='ocean_graph_partition')[source]

A step for partitioning the ocean graph into the core counts E3SM runs use.

The graph itself comes from the cull step – the ocean prefix, which is the domain the ocean initial condition is built on – so nothing is regenerated here.

Variables:

cull_mesh_step (polaris.tasks.e3sm.init.topo.cull.CullMeshStep) – The step that wrote the ocean graph.

__init__(component, subdir, cull_mesh_step, name='ocean_graph_partition')[source]

Create a new step.

Parameters:

Methods

__init__(component, subdir, cull_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)

Take the number of partitions to build at once from the config.

get_core_counts(ncells)

The core counts to partition a mesh into, from the config's bounds.

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()

Partition graph.info into each core count.

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()

Refuse a model whose packaging is not supported, before anything runs.

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