class compass.ocean.tests.global_ocean.init.initial_state.InitialState(test_case, mesh, initial_condition, with_bgc)[source]

A step for creating a mesh and initial condition for baroclinic channel test cases

  • mesh (compass.ocean.tests.global_ocean.mesh.mesh.MeshStep) – The step for creating the mesh

  • initial_condition ({'PHC', 'EN4_1900'}) – The initial condition dataset to use

  • with_bgc (bool) – Whether to include biogeochemistry (BGC) in the initial condition

__init__(test_case, mesh, initial_condition, with_bgc)[source]

Create the step



__init__(test_case, mesh, initial_condition, ...)

Create the step

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.


Update resources at runtime from config options


Process the inputs to and outputs from a step added with compass.Step.add_input_file() and compass.Step.add_output_file().


Run this step of the testcase


Update attributes of the step at runtime before calling the run() method.

set_resources([cpus_per_task, ...])

Update the resources for the subtask.


Get resources at setup from config options

update_namelist_at_runtime(options[, out_name])

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.