polaris.tasks.ocean.horiz_press_grad.analysis.Analysis

class polaris.tasks.ocean.horiz_press_grad.analysis.Analysis(component, indir, dependencies)

A step for analyzing two-column HPGA errors versus a reference solution and versus the Python-computed initial-state solution.

Variables:

dependencies_dict (dict) –

A dictionary of dependent steps:

referencepolaris.Step

The reference step that produces reference_solution.nc

initdict

Mapping from horizontal resolution (km) to Init step

forwarddict

Mapping from horizontal resolution (km) to Forward step

__init__(component, indir, dependencies)

Create the analysis 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

• dependencies (dict) – A dictionary of dependent steps

Methods

__init__(component, indir, dependencies)	Create the analysis 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.
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, **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()	Add inputs from reference, init and forward steps
validate_baselines()	Compare variables between output files in this step and in the same step from a baseline run if one was provided.
write_model_dataset(ds, filename)	Write out the given dataset, mapping dimension and variable names from MPAS-Ocean to Omega names if appropriate

Attributes

component