polaris.tasks.ocean.single_column.thermo.conservation_summary.ConservationSummary

class polaris.tasks.ocean.single_column.thermo.conservation_summary.ConservationSummary(component, indir, forward_steps)

A step that gathers the conservation errors from each of the thermo forward steps into a single log file listing the forward step name and the mass, salt and energy errors.

Variables:

forward_steps (dict) – A mapping from forward step name to the path of that step’s work directory relative to the base work directory

__init__(component, indir, forward_steps)

Create the step

Parameters:

• component (polaris.Component) – The component the step belongs to

• indir (str) – The subdirectory that the task belongs to, that this step will go into a subdirectory of

• forward_steps (dict) – A mapping from forward step name to the path of that step’s work directory relative to the base work directory

Methods

__init__(component, indir, forward_steps)	Create the step
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_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()	Write a log file listing the conservation error for each forward step
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()	Set up the task in the work directory, including downloading any dependencies.
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