polaris.tasks.mesh.spherical.unified.sizing_field.VizSizingFieldStep

class polaris.tasks.mesh.spherical.unified.sizing_field.VizSizingFieldStep(component, sizing_step, subdir)[source]

Visualize sizing-field diagnostics produced by BuildSizingFieldStep.

The step writes a global overview plot, an active-control map, and a plain-text summary of min/max cell widths and provenance counts.

Variables:
  • sizing_step (polaris.Step) – The shared sizing-field build step whose output is visualized

  • output_filenames (list of str) – The names of the output files written by this step

__init__(component, sizing_step, subdir)[source]

Create a new step.

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

  • sizing_step (polaris.Step) – The shared sizing-field build step

  • subdir (str) – The subdirectory within the component work directory where the step runs

Methods

__init__(component, sizing_step, subdir)

Create a new 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 that must be produced by this step and may be made available as an input to steps, perhaps in other tasks.

check_properties()

This method should be overridden to check properties of step outputs

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

Create simple global diagnostic plots and a text summary.

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 sizing-field dataset and declare outputs.

validate_baselines()

Compare variables between output files in this step and in the same step from a baseline run if one was provided.