polaris.ocean.tasks.inertial_gravity_wave.analysis.Analysis

class polaris.ocean.tasks.inertial_gravity_wave.analysis.Analysis(component, resolutions, subdir, dependencies)

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

Variables:

resolutions (list of float) – The resolutions of the meshes that have been run

__init__(component, resolutions, subdir, dependencies)

Create the step

Parameters:

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

• resolutions (list of float) – The resolutions of the meshes that have been run

• subdir (str) – The subdirectory that the step resides in

• dependencies (dict of dict of polaris.Steps) – The dependencies of this step

Methods

__init__(component, resolutions, subdir, ...)	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.
compute_error(mesh_name, variable_name[, ...])	Compute the error for a given resolution
constrain_resources(available_resources)	Constrain cpus_per_task and ntasks based on the number of cores available to this step
convergence_parameters([field_name])	Get convergence parameters
exact_solution(mesh_name, field_name, time)	Get the exact solution
get_output_field(mesh_name, field_name, time)	Get the model output field at the given time and z index
plot_convergence(variable_name, title, zidx)	Compute the error norm for each resolution and produce a convergence plot
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.