compass.ocean.tests.hurricane.analysis.Analysis

class compass.ocean.tests.hurricane.analysis.Analysis(test_case, storm)[source]

A step for producing ssh validation plots at observation stations

Variables

  • frmt (str) – Format for datetimes

  • min_date (str) – Beginning of time period to plot in frmt format

  • max_data (str) – End of time period to plot in frmt format

  • pointstats_file (dict) – Dictionary of pointwiseStats outputs to plot. Dictionary key becomes the lable in the legend.

  • observation (dict) – Dictionary of stations belonging to a certain data product

__init__(test_case, storm)[source]

Create the step

Parameters

Methods

__init__(test_case, storm)

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.

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

Read the pointwiseStats data from the MPAS-Ocean run

read_station_data(obs_file, obs_type, ...)

Read the observed ssh timeseries data for a given station

read_station_file(station_file)

Read file containing station locations and names

run()

Run this step of the test case

setup()

Setup test case and download data

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.