polaris.tasks.ocean.Ocean

class polaris.tasks.ocean.Ocean

The collection of all test case for the MPAS-Ocean core

Variables:

• model (str) – The ocean model being used, either ‘mpas-ocean’ or ‘omega’

• mpaso_to_omega_dim_map (dict) – A map from MPAS-Ocean dimension names to their Omega equivalents

• mpaso_to_omega_var_map (dict) – A map from MPAS-Ocean variable names to their Omega equivalents

__init__()

Construct the collection of MPAS-Ocean test cases

Methods

__init__()	Construct the collection of MPAS-Ocean test cases
add_config(config)	Add a shared config to the component
add_step(step)	Add a step to the component
add_task(task)	Add a task to the component
configure(config)	Configure the component
get_or_create_shared_step(step_cls, subdir, ...)	Get a shared step from the component if it exists, otherwise create and add it.
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)
map_var_list_from_native_model(var_list)	If the model is Omega, rename variables from their Omega names to the MPAS-Ocean equivalent
map_var_list_to_native_model(var_list)	If the model is Omega, rename variables from their MPAS-Ocean names to the Omega equivalent (appropriate for validation variable lists)
open_model_dataset(filename, **kwargs)	Open the given dataset, mapping variable and dimension names from Omega to MPAS-Ocean names if appropriate
remove_step(step)	Remove the given step from this component
write_model_dataset(ds, filename)	Write out the given dataset, mapping dimension and variable names from MPAS-Ocean to Omega names if appropriate