- class compass.ocean.tests.ziso.forward.Forward(test_case, resolution, name='forward', subdir=None, with_analysis=False, with_frazil=False, long=False, with_particles=False)[source]¶
A step for performing forward MPAS-Ocean runs as part of ZISO test cases.
- __init__(test_case, resolution, name='forward', subdir=None, with_analysis=False, with_frazil=False, long=False, with_particles=False)[source]¶
Create a new test case
test_case (compass.TestCase) – The test case this step belongs to
resolution (str) – The resolution of the test case
name (str) – the name of the test case
subdir (str, optional) – the subdirectory for the step. The default is
with_analysis (bool, optional) – whether analysis members are enabled as part of the run
with_frazil (bool, optional) – whether the run includes frazil formation
long (bool, optional) – Whether to run a long (3-year) simulation to quasi-equilibrium
with_particles (bool, optional) – Whether particles are include in the simulation
__init__(test_case, resolution[, name, ...])
Create a new test case
add_input_file([filename, target, database, ...])
Add an input file to the step (but not necessarily to the MPAS model).
make a link to the model executable and add it to the inputs
add_namelist_file(package, namelist[, ...])
Add a file with updates to namelist options to the step to be parsed when generating a complete namelist file if and when the step gets set up.
add_namelist_options(options[, out_name, mode])
Add the namelist replacements to be parsed when generating a namelist file if and when the step gets set up.
Add the output file that must be produced by this step and may be made available as an input to steps, perhaps in other test cases.
add_streams_file(package, streams[, ...])
Add a streams file to the step to be parsed when generating a complete streams file if and when the step gets set up.
ntasksbased on the number of cores available to this step
Process the inputs to and outputs from a step added with
Run this step of the test case
Update attributes of the step at runtime before calling the
Update the resources for the subtask.
Set up the test case in the work directory, including downloading any dependencies.
Update an existing namelist file with additional options.
Modify the namelist so the number of PIO tasks and the stride between them consistent with the number of nodes and cores (one PIO task per node).
update_streams_at_runtime(package, streams, ...)
Update the streams files during the run phase of this step using the given template and replacements.