polaris.ocean.tasks.single_column.viz.Viz
- class polaris.ocean.tasks.single_column.viz.Viz(component, indir, ideal_age=False)[source]
A step for plotting the results of a single-column test
- __init__(component, indir, ideal_age=False)[source]
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
ideal_age (bool, optional) – Whether the initial condition should include the ideal age tracer
Methods
__init__
(component, indir[, ideal_age])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 that must be produced by this step and may be made available as an input to steps, perhaps in other tasks.
constrain_resources
(available_resources)Constrain
cpus_per_task
andntasks
based on the number of cores available to this stepprocess_inputs_and_outputs
()Process the inputs to and outputs from a step added with
polaris.Step.add_input_file()
andpolaris.Step.add_output_file()
.run
()Run this step of the test case
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.