polaris.ocean.tasks.inertial_gravity_wave.viz.Viz

class polaris.ocean.tasks.inertial_gravity_wave.viz.Viz(component, taskdir, dependencies, refinement='both')[source]

A step for visualizing the output from the inertial gravity wave test case

Variables:

  • dependencies_dict (dict of dict of polaris.Steps) –

    The dependencies of this step must be given as separate keys in the dict:

    meshdict of polaris.Steps

    Keys of the dict correspond to refinement_factors Values of the dict are polaris.Steps, which must have the attribute path, the path to base_mesh.nc of that resolution

    initdict of polaris.Steps

    Keys of the dict correspond to refinement_factors Values of the dict are polaris.Steps, which must have the attribute path, the path to initial_state.nc of that resolution

    forwarddict of polaris.Steps

    Keys of the dict correspond to refinement_factors Values of the dict are polaris.Steps, which must have the attribute path, the path to forward.nc of that resolution

  • refinement (str, optional) – Refinement type. One of ‘space’, ‘time’ or ‘both’ indicating both space and time

__init__(component, taskdir, dependencies, refinement='both')[source]

Create the step

Parameters:

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

  • taskdir (str) – The subdirectory that the task belongs to

  • dependencies (dict of dict of polaris.Steps) –

    The dependencies of this step must be given as separate keys in the dict:

    meshdict of polaris.Steps

    Keys of the dict correspond to refinement_factors Values of the dict are polaris.Steps, which must have the attribute path, the path to base_mesh.nc of that resolution

    initdict of polaris.Steps

    Keys of the dict correspond to refinement_factors Values of the dict are polaris.Steps, which must have the attribute path, the path to initial_state.nc of that resolution

    forwarddict of polaris.Steps

    Keys of the dict correspond to refinement_factors Values of the dict are polaris.Steps, which must have the attribute path, the path to forward.nc of that resolution

  • refinement (str, optional) – Refinement type. One of ‘space’, ‘time’ or ‘both’ indicating both space and time

Methods

__init__(component, taskdir, dependencies[, ...])

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

Add input files based on resolutions, which may have been changed by user config options

validate_baselines()

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