compass.landice.tests.mismipplus.setup_mesh.SetupMesh

class compass.landice.tests.mismipplus.setup_mesh.SetupMesh(test_case, name, subdir=None)[source]

A step for creating a mesh and initial condition for MISMIP+ test cases Experimental protocol described in: Asay-Davis, et al. 2016. “Experimental Design for Three Interrelated Marine Ice Sheet and Ocean Model Intercomparison Projects: MISMIP v.3 (MISMIP+), ISOMIP v.2 (ISOMIP+) and MISOMIP v.1 (MISOMIP1).” Geoscientific Model Development 9 (7): 2471–97. https://doi.org/10.5194/gmd-9-2471-2016.

Variables:

  • resolution (float) – The resolution of the test case, as defined in the configuration file at the time when compass setup is run.

  • nx (int) – The number of cells in the x direction

  • ny (int) – The number of cells in the y direction

  • dc (int) – The distance in meters between adjacent cell centers.

__init__(test_case, name, subdir=None)[source]

Create the step

Parameters:

  • test_case (compass.TestCase) – The test case this step belongs to

  • name (str) – the name of the test case

  • subdir (str, optional) – the subdirectory for the step. The default is name

Methods

__init__(test_case, name[, subdir])

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)

Constrain cpus_per_task and ntasks based on the number of cores available to this step

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 test case

runtime_setup()

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

set_resources([cpus_per_task, ...])

Update the resources for the subtask.

setup()

Set up the test case in the work directory, including downloading any dependencies.

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.