compass.ocean.tests.tides.analysis.Analysis

class compass.ocean.tests.tides.analysis.Analysis(test_case)[source]

A step for producing harmonic constituent errors and validation plots

Variables:

  • harmonic_analysis_file (str) – File containing MPAS-O constitents

  • grid_file (str) – Name of file containing MPAS-O mesh information

  • constituents (list) – List of constituents to extract from TPXO database

  • tpxo_version (str) – Version of TPXO to use in validation

__init__(test_case)[source]

Create the step

Parameters:

test_case (compass.ocean.tests.tides.forward.Forward) – The test case this step belongs to

Methods

__init__(test_case)

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.

append_tpxo_data()

Inject TPXO data into harmonic analysis file

check_tpxo_data()

Check if TPXO data exists in harmonic analysis file

constrain_resources(available_resources)

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

plot()

Calculate errors and plot consitituents

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

read_otps2_output(idx)

Read TPXO extraction output

run()

Run this step of the test case

run_otps2()

Perform TPXO extraction

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

Setup test case and download data

setup_otps2()

Write input files for TPXO extraction

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.

write_coordinate_file(idx)

Write mesh coordinates for TPXO extraction