compass.ocean.tests.global_ocean.init.initial_state.InitialState

class compass.ocean.tests.global_ocean.init.initial_state.InitialState(test_case, mesh, initial_condition, culled_topo_path=None, name='initial_state', subdir=None, adjustment_fraction=None)[source]

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

Variables:

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

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

  • adjustment_fraction (float) – The fraction of the way through iterative ssh adjustment for this step

__init__(test_case, mesh, initial_condition, culled_topo_path=None, name='initial_state', subdir=None, adjustment_fraction=None)[source]

Create the step

Parameters:

  • test_case (compass.ocean.tests.global_ocean.init.Init) – The test case this step belongs to

  • mesh (compass.ocean.tests.global_ocean.mesh.Mesh) – The test case that creates the mesh used by this test case

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

  • culled_topo_path (str, optional) – The path to a step where topography_culled.nc is provided

  • name (str, optional) – The name of the step

  • subdir (str, optional) – The subdirectory for the step

  • adjustment_fraction (float, optional) – The fraction of the way through iterative ssh adjustment for this step

Methods

__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).

add_model_as_input()

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_output_file(filename)

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.

constrain_resources(available_resources)

Update resources at runtime from config options

process_inputs_and_outputs()

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

run()

Run this step of the testcase

runtime_setup()

Update the Haney number at runtime based on the config option.

set_resources([cpus_per_task, ...])

Update the resources for the subtask.

setup()

Get resources at setup from config options

update_namelist_at_runtime(options[, out_name])

Update an existing namelist file with additional options.

update_namelist_pio([out_name])

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.