polaris.ocean.tasks.geostrophic.viz.Viz

class polaris.ocean.tasks.geostrophic.viz.Viz(component, name, subdir, base_mesh, init, forward, mesh_name)[source]

A step for plotting fields from the cosine bell output

Variables:

mesh_name (str) – The name of the mesh

__init__(component, name, subdir, base_mesh, init, forward, mesh_name)[source]

Create the step

Parameters:

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

  • name (str) – The name of the step

  • subdir (str) – The subdirectory in the test case’s work directory for the step

  • base_mesh (polaris.Step) – The base mesh step

  • init (polaris.Step) – The init step

  • forward (polaris.Step) – The init step

  • mesh_name (str) – The name of the mesh

Methods

__init__(component, name, subdir, base_mesh, ...)

Create the step

add_dependency(step[, name])

Add step as a dependency of this step (i.e.

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

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.