polaris.tasks.ocean.realistic_global.dynamic_adjustment.viz.VizDynamicAdjustmentStep

class polaris.tasks.ocean.realistic_global.dynamic_adjustment.viz.VizDynamicAdjustmentStep(component, subdir, stages, min_res=None, mesh_target=None, init_target=None)[source]

A step that plots the global-statistics time series of a completed dynamic-adjustment sequence.

It reads the same statistics files the summary step reduces, so the figure and the summary describe the same run. Like that step, it opens them by path rather than declaring them as inputs, so a stage that wrote no statistics is skipped rather than failing the step – a partial picture of a run that went wrong is more use than none. Also like that step, it declares each stage’s output.nc as an input, which is what makes a parallel run wait for the stages before plotting.

The step belongs to the standalone dynamic_adjustment task. If the stages are later reused as shared steps by a longer spin-up workflow, this should not come with them: it describes a completed adjustment, which is not what a workflow consuming the relaxed restart is asking about.

Variables:

stages (list of ForwardStage) – The stages of the adjustment, in schedule order.
min_res (float or None) – The mesh minimum resolution in km, used for a per-kilometer Omega timestep in the CFL estimate.
mesh_filename (str or None) – The local name of the horizontal mesh, if one was given.
init_filename (str or None) – The local name of the initial state, if one was given.

__init__(component, subdir, stages, min_res=None, mesh_target=None, init_target=None)[source]

Create the step.

Parameters:

component (polaris.tasks.ocean.Ocean) – The ocean component the step belongs to.
subdir (str) – The subdirectory for the step.
stages (list of ForwardStage) – The stages of the adjustment, in schedule order. Their start times are what place the stages on a common axis, and their damping is what the stage labels report.
min_res (float, optional) – The mesh minimum resolution in km, used for a per-kilometer Omega timestep in the CFL estimate.
mesh_target (str, optional) – The horizontal mesh, relative to the base work directory. Its cell areas weight the tracer-change histograms, and its smallest edge sets Omega’s CFL estimate. It is linked as mesh.nc.
init_target (str, optional) – The initial state the first stage starts from, relative to the base work directory. The tracer changes are measured from it. It is linked as init.nc.

Methods

`__init__`(component, subdir, stages[, ...])	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)	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`()	Read each stage's statistics and plot them as one series, then plot how far the adjustment moved temperature and salinity.
`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