compass.ocean.tests.isomip_plus.ocean_test.OceanTest¶
- class compass.ocean.tests.isomip_plus.ocean_test.OceanTest(test_group, resolution, experiment, vertical_coordinate, time_varying_forcing=False)[source]¶
An ISOMIP+ test case
- Variables
resolution (float) – The horizontal resolution (km) of the test case
experiment ({'Ocean0', 'Ocean1', 'Ocean2'}) – The ISOMIP+ experiment
vertical_coordinate (str) – The type of vertical coordinate (
z-star,z-level, etc.)time_varying_forcing (bool) – Whether the run includes time-varying land-ice forcing
- __init__(test_group, resolution, experiment, vertical_coordinate, time_varying_forcing=False)[source]¶
Create the test case
- Parameters
test_group (compass.ocean.tests.isomip_plus.IsomipPlus) – The test group that this test case belongs to
resolution (float) – The horizontal resolution (km) of the test case
experiment ({'Ocean0', 'Ocean1', 'Ocean2'}) – The ISOMIP+ experiment
vertical_coordinate (str) – The type of vertical coordinate (
z-star,z-level, etc.)time_varying_forcing (bool, optional) – Whether the run includes time-varying land-ice forcing
Methods
__init__(test_group, resolution, experiment, ...)Create the test case
add_step(step[, run_by_default])Add a step to the test case
check_validation()Check the test case's "validation" dictionary to see if validation failed.
Modify the configuration options for this test case.
run()Run each step of the test case
validate()Perform validation of variables