compass.ocean.tests.buttermilk_bay.viz.Viz

class compass.ocean.tests.buttermilk_bay.viz.Viz(test_case, wetdry, resolutions)

A step for visualizing buttermilk bay results

Variables:

wetdry (str) –

The wetting and drying approach used

resolutionslist

The grid resolutions run for this case

__init__(test_case, wetdry, resolutions)

Create the step

Parameters:

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

• wetdry (str) –

  The wetting and drying approach used

  resolutionslist

  The grid resolutions run for this case

Methods

__init__(test_case, wetdry, resolutions)	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
contour_plots(points)	Plot contour plots at a specified output interval for each resolution and show where the points used in points.png are located.
get_points()	Get the point coordinates for plotting solution timeseries
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.
timeseries_plots(points)	Plot solution timeseries at a given number of points for each resolution
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.