polaris.tasks.ocean.horiz_press_grad.init.Init

class polaris.tasks.ocean.horiz_press_grad.init.Init(component, horiz_res, vert_res, indir)[source]

A step for creating a mesh and initial condition for two column test cases

Variables:
  • horiz_res (float) – The horizontal resolution in km

  • vert_res (float) – The vertical resolution in m

__init__(component, horiz_res, vert_res, indir)[source]

Create the step

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

  • horiz_res (float) – The horizontal resolution in km

  • vert_res (float) – The vertical resolution in m

  • indir (str) – The subdirectory that the task belongs to, that this step will go into a subdirectory of

Methods

__init__(component, horiz_res, vert_res, indir)

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.

add_output_files_for_ocean_model_input([...])

Register output files that will be consumed by the ocean model as inputs (horizontal mesh, initial condition, and model-specific files).

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

map_from_native_model_vars(ds)

If the model is Omega, rename dimensions and variables in a dataset from their Omega names to the MPAS-Ocean equivalent (appropriate for datasets that are output from the model)

map_to_native_model_vars(ds)

If the model is Omega, rename dimensions and variables in a dataset from their MPAS-Ocean names to the Omega equivalent (appropriate for input datasets like an initial condition)

open_model_dataset(filename, config, **kwargs)

Open the given dataset, mapping variable and dimension names from Omega to MPAS-Ocean names if appropriate

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.

write_horiz_mesh_dataset(ds, filename, config)

Write a horizontal mesh dataset, validating that all expected mesh variables are present before writing.

write_initial_state_dataset(ds, filename, config)

Write an initial-state dataset, omitting horizontal mesh fields and (for Omega) vertical coordinate fields.

write_model_dataset(ds, filename, config)

Write out the given dataset, mapping dimension and variable names from MPAS-Ocean to Omega names if appropriate

write_vert_coord_dataset(ds, filename, config)

Write a vertical-coordinate dataset for Omega's InitialVertCoord stream.

Attributes

component