ocean

Ocean()

The collection of all test case for the MPAS-Ocean core

Test Groups

baroclinic_channel

BaroclinicChannel(mpas_core)

A test group for baroclinic channel test cases

configure(resolution, config)

Modify the configuration options for one of the baroclinic test cases

decomp_test.DecompTest(test_group, resolution)

A decomposition test case for the baroclinic channel test group, which makes sure the model produces identical results on 1 and 4 cores.

decomp_test.DecompTest.configure()

Modify the configuration options for this test case.

decomp_test.DecompTest.run()

This method is deprecated.

default.Default(test_group, resolution)

The default test case for the baroclinic channel test group simply creates the mesh and initial condition, then performs a short forward run on 4 cores.

default.Default.configure()

Modify the configuration options for this test case.

default.Default.run()

This method is deprecated.

restart_test.RestartTest(test_group, resolution)

A restart test case for the baroclinic channel test group, which makes sure the model produces identical results with one longer run and two shorter runs with a restart in between.

restart_test.RestartTest.configure()

Modify the configuration options for this test case.

restart_test.RestartTest.run()

This method is deprecated.

rpe_test.RpeTest(test_group, resolution)

The reference potential energy (RPE) test case for the baroclinic channel test group performs a 20-day integration of the model forward in time at 5 different values of the viscosity at the given resolution.

rpe_test.RpeTest.configure()

Modify the configuration options for this test case.

rpe_test.RpeTest.run()

This method is deprecated.

rpe_test.analysis.Analysis(test_case, ...)

A step for plotting the results of a series of RPE runs in the baroclinic channel test group

rpe_test.analysis.Analysis.setup()

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

rpe_test.analysis.Analysis.run()

Run this step of the test case

threads_test.ThreadsTest(test_group, resolution)

A thread test case for the baroclinic channel test group, which makes sure the model produces identical results with 1 and 2 threads.

threads_test.ThreadsTest.configure()

Modify the configuration options for this test case.

threads_test.ThreadsTest.run()

This method is deprecated.

forward.Forward(test_case, resolution[, ...])

A step for performing forward MPAS-Ocean runs as part of baroclinic channel test cases.

forward.Forward.setup()

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

forward.Forward.run()

Run this step of the test case

initial_state.InitialState(test_case, resolution)

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

initial_state.InitialState.setup()

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

initial_state.InitialState.run()

Run this step of the test case

buttermilk_bay

ButtermilkBay(mpas_core)

A test group for Buttermilk Bay (subgrid wetting-and-drying) test cases

default.Default(test_group, wetdry)

The default buttermilk_bay test case

default.Default.configure()

Set config options for the test case

default.Default.update_cores()

Update the number of cores and min_tasks for each forward step

default.Default.validate()

Validate variables against a baseline

forward.Forward(test_case, resolution, name)

A step for performing forward MPAS-Ocean runs as part of buttermilk bay test cases.

forward.Forward.run()

Run this step of the testcase

forward.Forward.setup()

Set namelist options based on config options

forward.Forward.get_dt()

Get the time step

initial_state.InitialState(test_case, name, ...)

A step for creating a mesh and initial condition for buttermilk bay test cases

initial_state.InitialState.run()

Run this step of the test case

viz.Viz(test_case, wetdry, resolutions)

A step for visualizing buttermilk bay results

viz.Viz.run()

Run this step of the test case

viz.Viz.get_points()

Get the point coordinates for plotting solution timeseries

viz.Viz.timeseries_plots(points)

Plot solution timeseries at a given number of points for each resolution

viz.Viz.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.

baroclinic_gyre

BaroclinicGyre(mpas_core)

A test group for baroclinic gyre test cases

GyreTestCase(test_group, resolution, long)

A class to define the baroclinic gyre test cases

GyreTestCase.configure()

Set config options for the test case

cull_mesh.CullMesh(test_case)

Cull a global mesh to only a single basin

cull_mesh.CullMesh.run()

Run this step of the test case

forward.Forward(test_case, resolution[, ...])

A step for performing forward MPAS-Ocean runs as part of the baroclinic gyre test cases.

forward.Forward.run()

Run this step of the test case

initial_state.InitialState(test_case, resolution)

A step for creating the initial condition for the baroclinic gyre test cases

initial_state.InitialState.run()

Run this step of the test case

moc.Moc(test_case, resolution)

A step for computing the zonally-averaged meridional overturning streamfunction in the single basin of the baroclinic gyre

moc.Moc.run()

Run this step of the test case

viz.Viz(test_case, resolution)

A step for visualizing output from baroclinic gyre

viz.Viz.run()

Run this step of the test case

dam_break

DamBreak(mpas_core)

A test group for dam break (wetting-and-drying) test cases

default.Default(test_group, resolution, use_lts)

The default dam_break test case

default.Default.configure()

Modify the configuration options for this test case.

forward.Forward(test_case, resolution, use_lts)

A step for performing forward MPAS-Ocean runs as part of dam break test cases.

forward.Forward.run()

Run this step of the test case

initial_state.InitialState(test_case, use_lts)

A step for creating a mesh and initial condition for dam break test cases

initial_state.InitialState.run()

Run this step of the test case

viz.Viz(test_case)

A step for visualizing dam break results, as well as comparison with experimental data and ROMS simulation output (Warner et al. 2013).

viz.Viz.run()

Run this step of the test case

drying_slope

DryingSlope(mpas_core)

A test group for drying slope (wetting-and-drying) test cases

analysis.Analysis(test_case, resolutions, ...)

A step for analyzing the convergence of drying slope results and producing a convergence plot.

analysis.Analysis.run()

Run this step of the test case

convergence.Convergence(test_group, ...)

The convergence drying_slope test case

convergence.Convergence.validate()

Validate variables against a baseline

decomp.Decomp(test_group, resolution, ...)

A decomposition test case for the baroclinic channel test group, which makes sure the model produces identical results on 1 and 12 cores.

decomp.Decomp.validate()

Test cases can override this method to perform validation of variables and timers

default.Default(test_group, resolution, ...)

The default drying_slope test case

default.Default.validate()

Validate variables against a baseline

forward.Forward(test_case, resolution[, ...])

A step for performing forward MPAS-Ocean runs as part of drying slope test cases.

forward.Forward.run()

Run this step of the test case

initial_state.InitialState(test_case, resolution)

A step for creating a mesh and initial condition for drying slope test cases

initial_state.InitialState.run()

Run this step of the test case

loglaw.LogLaw(test_group, resolution, ...)

The drying_slope test case with log-law drag

loglaw.LogLaw.configure()

Change config options as needed

loglaw.LogLaw.validate()

Validate variables against a baseline

viz.Viz(test_case[, damping_coeffs])

A step for visualizing drying slope results, as well as comparison with analytical solution and ROMS results.

viz.Viz.run()

Run this step of the test case

global_convergence

GlobalConvergence(mpas_core)

A test group for setting up global initial conditions and performing regression testing and dynamic adjustment for MPAS-Ocean

cosine_bell

CosineBell(test_group, icosahedral)

A test case for creating a global MPAS-Ocean mesh

CosineBell.configure()

Set config options for the test case

CosineBell.run()

This method is deprecated.

init.Init(test_case, mesh_name)

A step for an initial condition for for the cosine bell test case

init.Init.run()

Run this step of the testcase

forward.Forward(test_case, resolution, mesh_name)

A step for performing forward MPAS-Ocean runs as part of the cosine bell test case

forward.Forward.setup()

Set namelist options base on config options

forward.Forward.run()

Run this step of the testcase

forward.Forward.get_dt()

Get the time step

analysis.Analysis(test_case, resolutions, ...)

A step for visualizing the output from the cosine bell test case

analysis.Analysis.run()

Run this step of the test case

analysis.Analysis.rmse(mesh_name)

Compute the RMSE for a given resolution

global_ocean

test cases and steps

GlobalOcean(mpas_core)

A test group for setting up global initial conditions and performing regression testing and dynamic adjustment for MPAS-Ocean

analysis_test.AnalysisTest(test_group, mesh, ...)

A test case for performing a short forward run with an MPAS-Ocean global initial condition and check nearly all MPAS-Ocean analysis members to make sure they run successfully and output is identical to a baseline (if one is provided).

analysis_test.AnalysisTest.configure()

Modify the configuration options for this test case

analysis_test.AnalysisTest.run()

This method is deprecated.

daily_output_test.DailyOutputTest(...)

A test case to test the output for the TimeSeriesStatMonthly analysis member in E3SM.

daily_output_test.DailyOutputTest.configure()

Modify the configuration options for this test case

daily_output_test.DailyOutputTest.run()

This method is deprecated.

decomp_test.DecompTest(test_group, mesh, ...)

A test case for performing two short forward runs to make sure the results are identical with 4 and 8 cores

decomp_test.DecompTest.configure()

Modify the configuration options for this test case

decomp_test.DecompTest.run()

This method is deprecated.

files_for_e3sm.FilesForE3SM(test_group[, ...])

A test case for assembling files needed for MPAS-Ocean and MPAS-Seaice initial conditions in E3SM as well as files needed for diagnostics from the Meridional Overturning Circulation analysis member and MPAS-Analysis

files_for_e3sm.FilesForE3SM.configure()

Modify the configuration options for this test case

files_for_e3sm.FilesForE3SM.run()

This method is deprecated.

files_for_e3sm.ocean_graph_partition.OceanGraphPartition(...)

A step for creating graph partition files for the ocean mesh

files_for_e3sm.ocean_graph_partition.OceanGraphPartition.run()

Run this step of the testcase

files_for_e3sm.ocean_initial_condition.OceanInitialCondition(...)

A step for creating an E3SM ocean initial condition from the results of a dynamic-adjustment process to dissipate fast waves

files_for_e3sm.ocean_initial_condition.OceanInitialCondition.run()

Run this step of the testcase

files_for_e3sm.ocean_mesh.OceanMesh(test_case)

A step for creating an MPAS-Ocean mesh from variables from an MPAS-Ocean initial state file

files_for_e3sm.ocean_mesh.OceanMesh.run()

Run this step of the testcase

files_for_e3sm.scrip.Scrip(test_case)

A step for creating SCRIP files from the MPAS-Ocean mesh

files_for_e3sm.scrip.Scrip.run()

Run this step of the testcase

files_for_e3sm.seaice_graph_partition.SeaiceGraphPartition(...)

A step for creating graph partition files for the sea-ice mesh

files_for_e3sm.seaice_graph_partition.SeaiceGraphPartition.run()

Run this step of the testcase

files_for_e3sm.seaice_initial_condition.SeaiceInitialCondition(...)

A step for creating an E3SM sea-ice initial condition from variables from an MPAS-Ocean restart file

files_for_e3sm.seaice_initial_condition.SeaiceInitialCondition.run()

Run this step of the testcase

files_for_e3sm.seaice_mesh.SeaiceMesh(test_case)

A step for creating an MPAS-Seaice mesh from variables from an MPAS-Ocean initial state file

files_for_e3sm.seaice_mesh.SeaiceMesh.run()

Run this step of the testcase

files_for_e3sm.e3sm_to_cmip_maps.E3smToCmipMaps(...)

A step for creating mapping files from the MPAS-Ocean mesh to a standard CMIP6 mesh

files_for_e3sm.e3sm_to_cmip_maps.E3smToCmipMaps.run()

Run this step of the testcase

files_for_e3sm.diagnostic_maps.DiagnosticMaps(...)

A step for creating mapping files for use in MPAS-Analysis

files_for_e3sm.diagnostic_maps.DiagnosticMaps.run()

Run this step of the testcase

files_for_e3sm.diagnostic_masks.DiagnosticMasks(...)

A step for creating region masks needed for the Meridional Overturning Circulation analysis member and diagnostics from MPAS-Analysis

files_for_e3sm.diagnostic_masks.DiagnosticMasks.run()

Run this step of the testcase

files_for_e3sm.remap_ice_shelf_melt.RemapIceShelfMelt(...)

A step for for remapping observed melt rates to the MPAS grid and staging them in assembled_files

files_for_e3sm.remap_ice_shelf_melt.RemapIceShelfMelt.run()

Run this step of the test case

files_for_e3sm.remap_sea_surface_salinity_restoring.RemapSeaSurfaceSalinityRestoring(...)

A step for for remapping sea surface salinity (SSS) from the Polar science center Hydrographic Climatology (PHC) to the current MPAS mesh

files_for_e3sm.remap_sea_surface_salinity_restoring.RemapSeaSurfaceSalinityRestoring.run()

Run this step of the test case

files_for_e3sm.remap_iceberg_climatology.RemapIcebergClimatology(...)

A step for for remapping iceberg freshwater fluxes from a climatology from Merino et al. (2016) to the current MPAS mesh.

files_for_e3sm.remap_iceberg_climatology.RemapIcebergClimatology.run()

Run this step of the test case

files_for_e3sm.remap_tidal_mixing.RemapTidalMixing(...)

A step for for remapping the RMS tidal velocity from the CATS model (https://www.usap-dc.org/view/dataset/601235) to the current MPAS mesh

files_for_e3sm.remap_tidal_mixing.RemapTidalMixing.run()

Run this step of the test case

files_for_e3sm.write_coeffs_reconstruct.WriteCoeffsReconstruct(...)

A step for writing out coeffs_reconstruct for a given MPAS mesh

files_for_e3sm.write_coeffs_reconstruct.WriteCoeffsReconstruct.run()

Run this step of the testcase

init.Init(test_group, mesh, initial_condition)

A test case for creating initial conditions on a global MPAS-Ocean mesh

init.Init.configure([config])

Modify the configuration options for this test case

init.Init.run()

This method is deprecated.

init.initial_state.InitialState(test_case, ...)

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

init.initial_state.InitialState.setup()

Get resources at setup from config options

init.initial_state.InitialState.run()

Run this step of the testcase

init.remap_ice_shelf_melt.RemapIceShelfMelt(...)

A step for for remapping observed melt rates to the MPAS grid

init.remap_ice_shelf_melt.RemapIceShelfMelt.run()

Run this step of the test case

init.remap_ice_shelf_melt.remap_paolo(...[, ...])

Remap the Paolo et al. (2023; https://doi.org/10.5194/tc-17-3409-2023) melt rates at ~2 km resolution to an MPAS mesh.

init.remap_ice_shelf_melt.remap_adusumilli(...)

Remap the Adusumilli et al. (2020) melt rates at 0.5 km resolution to an MPAS mesh.

init.ssh_adjustment.SshAdjustment(test_case, ...)

A step for iteratively adjusting the pressure from the weight of the ice shelf to match the sea-surface height as part of ice-shelf 2D test cases

init.ssh_adjustment.SshAdjustment.setup()

Set the number of MPI tasks and the time step based on config options

init.ssh_adjustment.SshAdjustment.run()

Run this step of the testcase

init.ssh_from_surface_density.SshFromSurfaceDensity(...)

Compute the sea surface height that is in approximate hydrostatic balance with a given land-ice pressure using the density in the top layer of the ocean

init.ssh_from_surface_density.SshFromSurfaceDensity.run()

Run this step of the testcase

mesh.Mesh(test_group, mesh_name, ...)

A test case for creating a global MPAS-Ocean mesh

mesh.Mesh.configure([config])

Modify the configuration options for this test case

mesh.Mesh.run()

This method is deprecated.

mesh.ec30to60.EC30to60BaseMesh(test_case[, ...])

A step for creating EC30to60 and ECwISC30to60 meshes

mesh.ec30to60.EC30to60BaseMesh.build_cell_width_lat_lon()

Create cell width array for this mesh on a regular latitude-longitude grid

mesh.qu.IcosMeshFromConfigStep(test_case[, ...])

A step for creating quasi-uniform meshes at a resolution given by a config option

mesh.qu.IcosMeshFromConfigStep.setup()

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

mesh.qu.QUMeshFromConfigStep(test_case[, ...])

A step for creating quasi-uniform meshes at a resolution given by a config option

mesh.qu.QUMeshFromConfigStep.setup()

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

mesh.rrs6to18.RRS6to18BaseMesh(test_case[, ...])

A step for creating RRS6to18 and RRSwISC6to18 meshes

mesh.rrs6to18.RRS6to18BaseMesh.build_cell_width_lat_lon()

Create cell width array for this mesh on a regular latitude-longitude grid

mesh.so12to30.SO12to30BaseMesh(test_case[, ...])

A step for creating SO12to30 meshes

mesh.so12to30.SO12to30BaseMesh.build_cell_width_lat_lon()

Create cell width array for this mesh on a regular latitude-longitude grid

mesh.wc14.WC14BaseMesh(test_case[, name, ...])

A step for creating WC14 mesh

mesh.wc14.WC14BaseMesh.build_cell_width_lat_lon()

Create cell width array for this mesh on a regular latitude-longitude grid

performance_test.PerformanceTest(test_group, ...)

A test case for performing one or more short forward run with an MPAS-Ocean global initial condition assess performance, test prognostic and data melting (if ice-shelf cavities are present), and compare with previous results

performance_test.PerformanceTest.configure()

Modify the configuration options for this test case

performance_test.PerformanceTest.run()

This method is deprecated.

restart_test.RestartTest(test_group, mesh, ...)

A test case for performing two forward run, one without a restart and one with to make sure the results are identical

restart_test.RestartTest.configure()

Modify the configuration options for this test case

restart_test.RestartTest.run()

This method is deprecated.

threads_test.ThreadsTest(test_group, mesh, ...)

A test case for performing two short forward runs to make sure the results are identical with 1 and 2 thread per MPI process

threads_test.ThreadsTest.configure()

Modify the configuration options for this test case

threads_test.ThreadsTest.run()

This method is deprecated.

dynamic_adjustment.DynamicAdjustment(...)

A parent test case for performing dynamic adjustment (dissipating fast-moving waves) from an MPAS-Ocean initial condition.

dynamic_adjustment.DynamicAdjustment.validate()

Test cases can override this method to perform validation of variables and timers

forward.ForwardTestCase(test_group, mesh, ...)

A parent class for test cases for forward runs with global MPAS-Ocean mesh

forward.ForwardTestCase.configure()

Modify the configuration options for this test case

forward.ForwardTestCase.run()

This method is deprecated.

forward.ForwardStep(test_case, mesh, ...[, ...])

A step for performing forward MPAS-Ocean runs as part of global ocean test cases.

forward.ForwardStep.setup()

Set the number of MPI tasks and the time step based on config options

forward.ForwardStep.run()

Run this step of the testcase

global_ocean framework

metadata.get_e3sm_mesh_names(config, levels)

Get short and long E3SM mesh name from config options and the given number of vertical levels (typically taken from an initial condition or restart file).

metadata.add_mesh_and_init_metadata(...)

Add MPAS mesh and initial condition metadata to NetCDF outputs of the given step

tasks.get_ntasks_from_cell_count(config, ...)

Computes ntasks and min_tasks for a step based on the estimated (at setup) or exact (at runtime) mesh size

gotm

Gotm(mpas_core)

A test group for General Ocean Turbulence Model (GOTM) test cases

default

Default(test_group)

The default test case for the General Ocean Turbulence Model (GOTM) test group creates an initial condition on a 4 x 4 cell, doubly periodic grid, performs a short simulation, then vertical plots of the velocity and viscosity.

Default.validate()

Validate variables against a baseline

init.Init(test_case)

A step for creating a mesh and initial condition for General Ocean Turbulence Model (GOTM) test cases

init.Init.run()

Run this step of the test case

forward.Forward(test_case)

A step for performing forward MPAS-Ocean runs as part of General Ocean Turbulence Model (GOTM) test cases.

forward.Forward.run()

Run this step of the test case

analysis.Analysis(test_case)

A step for plotting the results of the default General Ocean Turbulence Model (GOTM) test case

analysis.Analysis.run()

Run this step of the test case

hurricane

test cases and steps

Hurricane(mpas_core)

A test group for hurricane simulations with MPAS-Ocean

configure

mesh.Mesh(test_group, mesh_name, use_lts)

A test case for creating a global MPAS-Ocean mesh

mesh.Mesh.configure()

Modify the configuration options for this test case

mesh.Mesh.run()

This method is deprecated.

mesh.dequ120at30cr10rr2.DEQU120at30cr10rr2BaseMesh(...)

A step for creating DEQU120at30cr10rr2 meshes

mesh.dequ120at30cr10rr2.DEQU120at30cr10rr2BaseMesh.build_cell_width_lat_lon()

Create cell width array for this mesh on a regular latitude-longitude grid

init.Init(test_group, mesh, storm, use_lts)

A test case for creating initial conditions on a global MPAS-Ocean mesh

init.Init.configure()

Modify the configuration options for this test case

init.Init.run()

This method is deprecated.

init.create_pointstats_file.CreatePointstatsFile(...)

A step for creating the input file for the pointwiseStats analysis member

init.create_pointstats_file.CreatePointstatsFile.create_pointstats_file(...)

Find grid points nearest to observation stations and create pointwiseStats file

init.create_pointstats_file.CreatePointstatsFile.run()

Run this step of the testcase

init.initial_state.InitialState(test_case, ...)

A step for creating a mesh and initial condition for hurricane test cases

init.initial_state.InitialState.setup()

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

init.initial_state.InitialState.run()

Run this step of the testcase

init.interpolate_atm_forcing.InterpolateAtmForcing(...)

A step for interpolating the atmospheric wind velocities and pressure onto the MPAS-Ocean mesh to be used as time varying forcing in the forward run

init.interpolate_atm_forcing.InterpolateAtmForcing.interpolate_data_to_grid(...)

Interpolate time snaps of gridded data field to MPAS mesh

init.interpolate_atm_forcing.InterpolateAtmForcing.plot_interp_data(...)

Plot original gridded data and interpolated fields

init.interpolate_atm_forcing.InterpolateAtmForcing.write_to_file(...)

Write data to netCDF file

init.interpolate_atm_forcing.InterpolateAtmForcing.run()

Run this step of the test case

forward.Forward(test_group, mesh, storm, ...)

A test case for performing a forward run for a hurricane case

forward.Forward.configure()

Modify the configuration options for this test case

forward.Forward.run()

This method is deprecated.

forward.forward.ForwardStep(test_case, mesh, ...)

A step for performing forward MPAS-Ocean runs as part of hurricane test cases.

forward.forward.ForwardStep.setup()

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

forward.forward.ForwardStep.run()

Run this step of the testcase

analysis.Analysis(test_case, storm)

A step for producing ssh validation plots at observation stations

analysis.Analysis.setup()

Setup test case and download data

analysis.Analysis.read_pointstats(...)

Read the pointwiseStats data from the MPAS-Ocean run

analysis.Analysis.read_station_data(...)

Read the observed ssh timeseries data for a given station

analysis.Analysis.read_station_file(station_file)

Read file containing station locations and names

analysis.Analysis.run()

Run this step of the test case

lts.mesh.lts_regions.LTSRegionsStep(...[, ...])

A step for adding LTS regions to a global MPAS-Ocean mesh

lts.mesh.lts_regions.LTSRegionsStep.setup()

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

lts.mesh.lts_regions.LTSRegionsStep.run()

Run this step of the test case

lts.mesh.lts_regions.label_mesh(fine_region, ...)

lts.init.topographic_wave_drag.ComputeTopographicWaveDrag(...)

A step for computing the topographic wave drag forcing term

lts.init.topographic_wave_drag.ComputeTopographicWaveDrag.interpolate_data_to_grid(...)

Interpolate time snaps of gridded data field to MPAS mesh

lts.init.topographic_wave_drag.ComputeTopographicWaveDrag.write_to_file(...)

Write data to netCDF file

lts.init.topographic_wave_drag.ComputeTopographicWaveDrag.run()

Run this step of the test case

ice_shelf_2d

IceShelf2d(mpas_core)

A test group for ice-shelf 2D test cases

configure(resolution, coord_type, config)

Modify the configuration options for this test case

default.Default(test_group, resolution, ...)

The default ice-shelf 2D test case, which performs a short forward run with the z-star vertical coordinate and with 15 iterations of adjustment to make the pressure from the weight of the ice shelf match the sea-surface height

default.Default.configure()

Modify the configuration options for this test case.

default.Default.run()

This method is deprecated.

restart_test.RestartTest(test_group, ...)

A restart test case for the ice-shelf 2D test case test group, which makes sure the model produces identical results with one longer run and two shorter runs with a restart in between.

restart_test.RestartTest.configure()

Modify the configuration options for this test case.

restart_test.RestartTest.run()

This method is deprecated.

forward.Forward(test_case, resolution, ...)

A step for performing forward MPAS-Ocean runs as part of ice-shelf 2D test cases.

forward.Forward.setup()

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

forward.Forward.run()

Run this step of the test case

initial_state.InitialState(test_case, resolution)

A step for creating a mesh and initial condition for ice-shelf 2D test cases

initial_state.InitialState.run()

Run this step of the test case

ssh_adjustment.SshAdjustment(test_case, ...)

A step for iteratively adjusting the pressure from the weight of the ice shelf to match the sea-surface height as part of ice-shelf 2D test cases

ssh_adjustment.SshAdjustment.setup()

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

ssh_adjustment.SshAdjustment.run()

Run this step of the test case

viz.Viz(test_case)

A step for visualizing a cross-section through the 2D ice-shelf domain

viz.Viz.run()

Run this step of the test case

internal_wave

InternalWave(mpas_core)

A test group for General Ocean Turbulence Model (GOTM) test cases

default.Default(test_group[, vlr])

The default test case for the internal wave test

default.Default.validate()

Validate variables against a baseline

rpe_test.RpeTest(test_group[, vlr])

The reference potential energy (RPE) test case for the internal wave test group performs a 20-day integration of the model forward in time at 5 different values of the viscosity at the given resolution.

rpe_test.analysis.Analysis(test_case, nus)

A step for plotting the results of a series of RPE runs in the internal wave test group

rpe_test.analysis.Analysis.run()

Run this step of the test case

ten_day_test.TenDayTest(test_group)

The default test case for the internal wave test

ten_day_test.TenDayTest.validate()

Validate variables against a baseline

forward.Forward(test_case[, name, subdir, ...])

A step for performing forward MPAS-Ocean runs as part of internal wave test cases.

forward.Forward.run()

Run this step of the test case

initial_state.InitialState(test_case)

A step for creating a mesh and initial condition for internal wave test cases

initial_state.InitialState.run()

Run this step of the test case

viz.Viz(test_case)

A step for visualizing a cross-section through the internal wave

viz.Viz.run()

Run this step of the test case

isomip_plus

IsomipPlus(mpas_core)

A test group for ice-shelf 2D test cases

isomip_plus_test.IsomipPlusTest(test_group, ...)

An ISOMIP+ test case

isomip_plus_test.IsomipPlusTest.configure()

Modify the configuration options for this test case.

isomip_plus_test.IsomipPlusTest.run()

This method is deprecated.

viz.Viz(test_case, resolution, experiment[, ...])

A step for visualizing output from an ISOMIP+ simulation

viz.Viz.run()

Run this step of the test case

viz.file_complete(ds, fileName)

Find out if the file already has the same number of time slices as the monthly-mean data set

viz.plot.TimeSeriesPlotter([inFolder, ...])

A plotter object to hold on to some info needed for plotting time series from ISOMIP+ simulation results

viz.plot.TimeSeriesPlotter.plot_melt_time_series([...])

Plot a series of image for each of several variables related to melt at the ice shelf-ocean interface: mean melt rate, total melt flux, mean thermal driving, mean friction velocity

viz.plot.TimeSeriesPlotter.plot_time_series(da, ...)

viz.plot.MoviePlotter(inFolder, ...)

A plotter object to hold on to some info needed for plotting images from ISOMIP+ simulation results

viz.plot.MoviePlotter.plot_barotropic_streamfunction([...])

Plot a series of image of the barotropic streamfunction

viz.plot.MoviePlotter.plot_overturning_streamfunction([...])

Plot a series of image of the overturning streamfunction

viz.plot.MoviePlotter.plot_melt_rates([...])

Plot a series of image of the melt rate

viz.plot.MoviePlotter.plot_ice_shelf_boundary_variables()

Plot a series of image for each of several variables related to the ice shelf-ocean interface: heat flux from the ocean, heat flux into the ice, thermal driving, haline driving, and the friction velocity under ice

viz.plot.MoviePlotter.plot_temperature()

Plot a series of images of temperature at the sea surface or ice-ocean interface, sea floor and in an x-z section

viz.plot.MoviePlotter.plot_salinity()

Plot a series of images of salinity at the sea surface or ice-ocean interface, sea floor and in an x-z section

viz.plot.MoviePlotter.plot_potential_density()

Plot a series of images of salinity at the sea surface or ice-ocean interface, sea floor and in an x-z section

viz.plot.MoviePlotter.plot_horiz_series(da, ...)

Plot a series of image of a given variable

viz.plot.MoviePlotter.plot_3d_field_top_bot_section(da, ...)

Plot a series of images of a given 3D variable showing the value at the top (sea surface or ice-ocean interface), sea floor and in an x-z section

viz.plot.MoviePlotter.plot_layer_interfaces([...])

Plot layer interfaces, the sea surface height and the bottom topography of the cross section at fixed y.

viz.plot.MoviePlotter.images_to_movies(outFolder)

Convert all the image sequences into movies with ffmpeg

evap.update_evaporation_flux(...)

Update the "evaporation" fluxes used to keep sea level under control for the ISOMIP+ experiments.

forward.Forward(test_case, resolution, ...)

A step for performing forward MPAS-Ocean runs as part of ice-shelf 2D test cases.

forward.Forward.setup()

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

forward.Forward.run()

Run this step of the test case

geom.interpolate_ocean_mask(ds_mesh, ...)

Interpolate the ocean mask from the original BISICLES grid to the MPAS mesh.

geom.interpolate_geom(ds_mesh, ds_geom, ...)

Interpolate the ice geometry from the original BISICLES grid to the MPAS mesh.

initial_state.InitialState(test_case, ...)

A step for creating a mesh and initial condition for ISOMIP+ test cases

initial_state.InitialState.run()

Run this step of the test case

misomip.Misomip(test_case, resolution, ...)

A step for interpolating output to the MISOMIP1 grid from an ISOMIP+ simulation

misomip.Misomip.run()

Run this step of the test case

process_geom.ProcessGeom(test_case, ...)

A step for processing the ISOMIP+ geometry for a given experiment

process_geom.ProcessGeom.run()

Run this step of the test case

ssh_adjustment.SshAdjustment(test_case, ...)

A step for iteratively adjusting the pressure from the weight of the ice shelf to match the sea-surface height as part of ice-shelf 2D test cases

ssh_adjustment.SshAdjustment.setup()

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

ssh_adjustment.SshAdjustment.run()

Run this step of the test case

streamfunction.Streamfunction(test_case, ...)

A step for computing the barotropic and overturning streamfunctions from ISOMIP+ simulation results

streamfunction.Streamfunction.run()

Run this step of the test case

lock_exchange

LockExchange(mpas_core)

A test group for lock exchange type test cases

hydro.Hydro(test_group)

The hydro test case for the lock exchange group simply creates the mesh and initial condition, then performs a forward run with the standard hydrostatic version of MPAS-O, and then plots the density profile.

nonhydro.Nonhydro(test_group)

The nonhydro test case for the lock exchange group simply creates the mesh and initial condition, then performs a forward runs with the nonhydrostatic version of MPAS-O, and then plots the density profile.

forward.Forward(test_case, name[, ntasks, ...])

A step for performing forward MPAS-Ocean runs as part of the lock exchange test case.

forward.Forward.run()

Run this step of the test case

initial_state.InitialState(test_case)

A step for creating a mesh and initial condition for the lock-exchange test case

initial_state.InitialState.run()

Run this step of the test case

visualize.Visualize(test_case)

A step for visualizing a cross-section through the density in the lock exchange test group

visualize.Visualize.run()

Run this step of the test case

merry_go_round

MerryGoRound(mpas_core)

A test group for tracer advection test cases "merry-go-round"

default.Default(test_group)

The default test case for the merry-go-round test

default.Default.validate()

Validate variables against a baseline

convergence_test.analysis.Analysis(...[, name])

A step for plotting the convergence of the solution with resolution and time step in the merry-go-round test group

convergence_test.analysis.Analysis.run()

Run this step of the test case

forward.Forward(test_case[, resolution, ...])

A step for performing forward MPAS-Ocean runs as part of merry-go-round test cases.

forward.Forward.run()

Run this step of the test case

initial_state.InitialState(test_case, resolution)

A step for creating a mesh and initial condition for the merry-go-round test cases

initial_state.InitialState.run()

Run this step of the test case

viz.Viz(test_case, resolution[, name])

A step for plotting the results of the merry-go-round test group

viz.Viz.run()

Run this step of the test case

nonhydro

Nonhydro(mpas_core)

A test group for nonhydrostatic test cases

stratified_seiche.StratifiedSeiche(test_group)

The default test case for the stratified seiche test simply creates the mesh and initial condition, then performs two forward runs, one with the standard hydrostatic version of MPAS-O, and the second with the nonhydrostatic version.

stratified_seiche.StratifiedSeiche.configure()

Modify the configuration options for this test case.

stratified_seiche.initial_state.InitialState(...)

A step for creating a mesh and initial condition for stratified seiche test case

stratified_seiche.initial_state.InitialState.setup()

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

stratified_seiche.initial_state.InitialState.run()

Run this step of the test case

stratified_seiche.forward.Forward(test_case, ...)

A step for performing forward MPAS-Ocean runs as part of the stratified seiche test case.

stratified_seiche.forward.Forward.setup()

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

stratified_seiche.forward.Forward.run()

Run this step of the test case

stratified_seiche.visualize.Visualize(test_case)

A step for visualizing a cross-section through the internal wave

stratified_seiche.visualize.Visualize.setup()

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

stratified_seiche.visualize.Visualize.run()

Run this step of the test case

solitary_wave.SolitaryWave(test_group)

The default test case for the solitary wave test simply creates the mesh and initial condition, then performs two forward runs, one with the standard hydrostatic version of MPAS-O, and the second with the nonhydrostatic version.

solitary_wave.SolitaryWave.configure()

Modify the configuration options for this test case.

solitary_wave.initial_state.InitialState(...)

A step for creating a mesh and initial condition for solitary wave test case

solitary_wave.initial_state.InitialState.setup()

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

solitary_wave.initial_state.InitialState.run()

Run this step of the test case

solitary_wave.forward.Forward(test_case, ...)

A step for performing forward MPAS-Ocean runs as part of the solitary wave test case.

solitary_wave.forward.Forward.setup()

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

solitary_wave.forward.Forward.run()

Run this step of the test case

solitary_wave.visualize.Visualize(test_case)

A step for visualizing a cross-section through the solitary wave

solitary_wave.visualize.Visualize.setup()

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

solitary_wave.visualize.Visualize.run()

Run this step of the test case

overflow

Overflow(mpas_core)

A test group for General Ocean Turbulence Model (GOTM) test cases

default.Default(test_group, resolution)

The default test case for the overflow test

rpe_test.RpeTest(test_group[, resolution])

The reference potential energy (RPE) test case for the overflow test group performs a 40h integration of the model forward in time at 5 different values of the viscosity at the given resolution.

rpe_test.analysis.Analysis(test_case, ...)

A step for plotting the results of a series of RPE runs in the overflow test group

rpe_test.analysis.Analysis.run()

Run this step of the test case

forward.Forward(test_case[, name, subdir, ...])

A step for performing forward MPAS-Ocean runs as part of overflow test cases.

forward.Forward.run()

Run this step of the test case

initial_state_from_init_mode.InitialStateFromInitMode(...)

A step for creating a mesh and initial condition for overflow test cases

initial_state_from_init_mode.InitialStateFromInitMode.run()

Run this step of the test case

initial_state.InitialState(test_case)

A step for creating a mesh and initial condition for the nonhydro and the hydro vs nonhydro test cases.

initial_state.InitialState.run()

Run this step of the test case

nonhydro.Nonhydro(test_group)

The nonhydro test case for the overflow test group creates the mesh and initial condition, then performs a forward runs with the nonhydrostatic version of MPAS-O.

nonhydro.forward.Forward(test_case, name[, ...])

A step for performing forward MPAS-Ocean runs as part of the nonhydro test case.

nonhydro.forward.Forward.run()

Run this step of the test case

hydro_vs_nonhydro.HydroVsNonhydro(test_group)

The hydro vs nonhydro test case for the overflow group creates the mesh and initial condition, then performs two forward runs, one with the standard hydrostatic version of MPAS-O, and the second with the nonhydrostatic version.

hydro_vs_nonhydro.forward.Forward(test_case, ...)

A step for performing forward MPAS-Ocean runs as part of the hydro vs nonhydro test case.

hydro_vs_nonhydro.forward.Forward.run()

Run this step of the test case

hydro_vs_nonhydro.visualize.Visualize(test_case)

A step for visualizing a cross-section through the fluid descend down the slope.

hydro_vs_nonhydro.visualize.Visualize.run()

Run this step of the test case

parabolic_bowl

ParabolicBowl(mpas_core)

A test group for parabolic bowl (wetting-and-drying) test cases

default.Default(test_group, ramp_type, ...)

The default parabolic_bowl test case

default.Default.configure()

Set config options for the test case

default.Default.update_cores()

Update the number of cores and min_tasks for each forward step

default.Default.validate()

Validate variables against a baseline

forward.Forward(test_case, resolution, name, ...)

A step for performing forward MPAS-Ocean runs as part of parabolic bowl test cases.

forward.Forward.run()

Run this step of the testcase

forward.Forward.setup()

Set namelist options based on config options

forward.Forward.get_dt()

Get the time step

initial_state.InitialState(test_case, name, ...)

A step for creating a mesh and initial condition for drying slope test cases

initial_state.InitialState.run()

Run this step of the test case

viz.Viz(test_case, ramp_type, wetdry, ...)

A step for visualizing parabolic bowl results and comparing with analytical solution

viz.Viz.run()

Run this step of the test case

viz.Viz.get_points()

Get the point coordinates for plotting solution timeseries

viz.Viz.timeseries_plots(points)

Plot solution timeseries at a given number of points for each resolution

viz.Viz.inject_exact_solution()

Save exact solution to output nc file

viz.Viz.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.

viz.Viz.rmse_plots()

Plot convergence curves

viz.Viz.compute_rmse(varname, filename)

Compute the rmse between the modeled and exact solutions

viz.Viz.exact_solution(var, x, y, t)

Evaluate the exact solution

planar_convergence

PlanarConvergence(mpas_core)

A test group for testing horizontal advection in MPAS-Ocean

conv_init.ConvInit(test_case, resolution)

A step for creating a mesh for a given resolution in a planar convergence test case.

conv_init.ConvInit.run()

Run this step of the test case

conv_test_case.ConvTestCase(test_group, name)

A test case for various convergence tests on in MPAS-Ocean with planar, doubly periodic meshes

conv_test_case.ConvTestCase.configure()

Set config options for the test case

conv_test_case.ConvTestCase.run()

This method is deprecated.

conv_test_case.ConvTestCase.update_cores()

Update the number of cores and min_tasks for each forward step

forward.Forward(test_case, resolution)

A step for performing forward MPAS-Ocean runs as part of a planar convergence test case

forward.Forward.setup()

Set namelist options base on config options

forward.Forward.run()

Run this step of the testcase

forward.Forward.get_dt_duration()

Get the time step and run duration as namelist options from config options

horizontal_advection

HorizontalAdvection(test_group)

A test case for testing horizontal advection in MPAS-Ocean with planar, doubly periodic meshes

HorizontalAdvection.configure()

Set config options for the test case

HorizontalAdvection.run()

This method is deprecated.

init.Init(test_case, resolution)

A step for creating an initial_condition for advection convergence test case

init.Init.run()

Run this step of the test case

analysis.Analysis(test_case, resolutions)

A step for visualizing the output from the advection convergence test case

analysis.Analysis.run()

Run this step of the test case

analysis.Analysis.rmse(resolution, variable)

Compute the RMSE for a given resolution

soma

Soma(mpas_core)

A test group for Simulating Ocean Mesoscale Activity (SOMA) test cases

soma_test_case.SomaTestCase(test_group, ...)

The class for all test cases in the SOMA test group.

soma_test_case.SomaTestCase.validate()

Test cases can override this method to perform validation of variables

analysis.Analysis(test_case, resolution)

A step for verifying that temperature and salinity profiles for SOMA case from particle interpolations are consistent with initialized profiles

analysis.Analysis.run()

Run this step of the test case

forward.Forward(test_case, resolution, ...)

A step for performing forward MPAS-Ocean runs as part of SOMA test cases.

forward.Forward.run()

Run this step of the test case

initial_state.InitialState(test_case, ...)

A step for creating a mesh and initial condition for SOMA test cases

initial_state.InitialState.run()

Run this step of the test case

sphere_transport

SphereTransport(mpas_core)

A test group for testing algorithms for passive tracer advection on the sphere

correlated_tracers_2d

CorrelatedTracers2D(test_group)

A test case for 2D transport on the sphere

CorrelatedTracers2D.configure()

Set config options for the test case

CorrelatedTracers2D.run()

This method is deprecated.

mesh.Mesh(test_case, resolution)

A step for creating uniform global meshes

mesh.Mesh.run()

Run this step of the test case

mesh.Mesh.build_cell_width_lat_lon()

Create cell width array for this mesh on a regular latitude-longitude grid

init.Init(test_case, resolution)

A step for an initial condition for for the cosine bell test case

init.Init.run()

Run this step of the testcase

forward.Forward(test_case, resolution, ...)

A step for performing forward MPAS-Ocean runs as part of the

forward.Forward.setup()

Set namelist options base on config options

forward.Forward.run()

Run this step of the testcase

forward.Forward.get_timestep_str()

These tests expect the time step to be input in units of minutes, but MPAS requires an "HH:MM:SS" string.

analysis.Analysis(test_case, resolutions)

A step for visualizing the output from the correlatedTracers2D test case

analysis.Analysis.run()

Run this step of the test case

divergent_2d

Divergent2D(test_group)

A test case for 2D transport on the sphere

Divergent2D.configure()

Set config options for the test case

Divergent2D.run()

This method is deprecated.

mesh.Mesh(test_case, resolution)

A step for creating uniform global meshes

mesh.Mesh.run()

Run this step of the test case

mesh.Mesh.build_cell_width_lat_lon()

Create cell width array for this mesh on a regular latitude-longitude grid

init.Init(test_case, resolution)

A step for an initial condition for for the cosine bell test case

init.Init.run()

Run this step of the testcase

forward.Forward(test_case, resolution, ...)

A step for performing forward MPAS-Ocean runs as part of the divergent_2d

forward.Forward.setup()

Set namelist options base on config options

forward.Forward.run()

Run this step of the testcase

forward.Forward.get_timestep_str()

These tests expect the time step to be input in units of minutes, but MPAS requires an "HH:MM:SS" string.

analysis.Analysis(test_case, resolutions)

A step for visualizing the output from the divergent2D test case

analysis.Analysis.run()

Run this step of the test case

nondivergent_2d

Nondivergent2D(test_group)

A test case for 2D transport on the sphere

Nondivergent2D.configure()

Set config options for the test case

Nondivergent2D.run()

This method is deprecated.

mesh.Mesh(test_case, resolution)

A step for creating uniform global meshes

mesh.Mesh.run()

Run this step of the test case

mesh.Mesh.build_cell_width_lat_lon()

Create cell width array for this mesh on a regular latitude-longitude grid

init.Init(test_case, resolution)

A step for an initial condition for for the cosine bell test case

init.Init.run()

Run this step of the testcase

forward.Forward(test_case, resolution, ...)

A step for performing forward MPAS-Ocean runs as part of the

forward.Forward.setup()

Set namelist options base on config options

forward.Forward.run()

Run this step of the testcase

forward.Forward.get_timestep_str()

These tests expect the time step to be input in units of minutes, but MPAS requires an "HH:MM:SS" string.

analysis.Analysis(test_case, resolutions)

A step for visualizing the output from the nondivergent2D test case

analysis.Analysis.run()

Run this step of the test case

rotation_2d

Rotation2D(test_group)

A test case for 2D transport on the sphere

Rotation2D.configure()

Set config options for the test case

Rotation2D.run()

This method is deprecated.

mesh.Mesh(test_case, resolution)

A step for creating uniform global meshes

mesh.Mesh.run()

Run this step of the test case

mesh.Mesh.build_cell_width_lat_lon()

Create cell width array for this mesh on a regular latitude-longitude grid

init.Init(test_case, resolution)

A step for an initial condition for for the cosine bell test case

init.Init.run()

Run this step of the testcase

forward.Forward(test_case, resolution, ...)

A step for performing forward MPAS-Ocean runs as part of the rotation_2d

forward.Forward.setup()

Set namelist options base on config options

forward.Forward.run()

Run this step of the testcase

forward.Forward.get_timestep_str()

These tests expect the time step to be input in units of minutes,

analysis.Analysis(test_case, resolutions)

A step for visualizing the output from the rotation_2d test case

analysis.Analysis.run()

Run this step of the test case

sphere_transport framework

process_output.compute_error_from_output_ncfile(dataset)

Given a netCDF4 Dataset associated with the output.nc file from a test case in the sphere_transport test group, this function computes the linf and l2 relative error values by comparing the final time step to the initial condition.

process_output.compute_convergence_rates(...)

Given a set of approximate mesh sizes (dlambda) and the corresponding linf and l2 relative error values, this function computes the approximate convergence rates for each error.

process_output.print_error_conv_table(...)

Print error values and approximate convergence rates to the console as a table.

process_output.read_ncl_rgb_file(cmap_filename)

Read a .rgb file from the NCAR Command Language, and return a matplotlib colormap.

process_output.plot_sol(fig, tcname, dataset)

Plot the solution at time 0, t = T/2, and T=T for test cases in the sphere_transport test group.

process_output.make_convergence_arrays(tcdata)

Collects data from a set of test case runs at different resolutions to use for convergence data analysis and plotting.

process_output.print_data_as_csv(tcname, tcdata)

Print test case data in csv format

process_output.plot_convergence(ax, tcname, ...)

Creates a convergence plot for a test case from the sphere_transport test group.

process_output.plot_filament(ax, tcname, ...)

Plot the "filament norm," as in figure 5 of LSPT2012.

process_output.plot_over_and_undershoot_errors(ax, ...)

Plots over- and under-shoot error as a function of time.

tides

test cases and steps

Tides(mpas_core)

A test group for tidal simulations with MPAS-Ocean

configure

mesh.Mesh(test_group, mesh_name)

A test case for creating a global MPAS-Ocean mesh

mesh.Mesh.configure()

Modify the configuration options for this test case

mesh.Mesh.run()

This method is deprecated.

init.Init(test_group, mesh)

A test case for creating initial conditions on a global MPAS-Ocean mesh

init.Init.configure()

Modify the configuration options for this test case

init.Init.run()

This method is deprecated.

init.remap_bathymetry.RemapBathymetry(...)

A step for remapping bathymetric data onto the MPAS-Ocean mesh

init.remap_bathymetry.RemapBathymetry.run()

Run this step of the test case

init.initial_state.InitialState(test_case, mesh)

A step for creating a mesh and initial condition for tidal test cases

init.initial_state.InitialState.setup()

Get resources at setup from config options

init.initial_state.InitialState.run()

Run this step of the testcase

init.interpolate_wave_drag.InterpolateWaveDrag(...)

A step for interpolating the topographic wave drag data onto the MPAS-Ocean mesh

init.interpolate_wave_drag.InterpolateWaveDrag.interpolate_data_to_grid(...)

Interpolate time snaps of gridded data field to MPAS mesh

init.interpolate_wave_drag.InterpolateWaveDrag.plot_interp_data(...)

Plot original gridded data and interpolated fields

init.interpolate_wave_drag.InterpolateWaveDrag.write_to_file(data)

Write data to netCDF file

init.interpolate_wave_drag.InterpolateWaveDrag.run()

Run this step of the test case

forward.Forward(test_group, mesh, init)

A test case for performing a forward run for a tidal case

forward.Forward.configure()

Modify the configuration options for this test case

forward.Forward.run()

This method is deprecated.

forward.forward.ForwardStep(test_case, mesh, ...)

A step for performing forward MPAS-Ocean runs as part of tides test cases.

forward.forward.ForwardStep.setup()

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

forward.forward.ForwardStep.run()

Run this step of the testcase

analysis.Analysis(test_case)

A step for producing harmonic constituent errors and validation plots

analysis.Analysis.setup()

Setup test case and download data

analysis.Analysis.write_coordinate_file(idx)

Write mesh coordinates for TPXO extraction

analysis.Analysis.setup_otps2()

Write input files for TPXO extraction

analysis.Analysis.run_otps2()

Perform TPXO extraction

analysis.Analysis.read_otps2_output(idx)

Read TPXO extraction output

analysis.Analysis.append_tpxo_data()

Inject TPXO data into harmonic analysis file

analysis.Analysis.check_tpxo_data()

Check if TPXO data exists in harmonic analysis file

analysis.Analysis.plot()

Calculate errors and plot consitituents

analysis.Analysis.run()

Run this step of the test case

utility

Utility(mpas_core)

A test group for general ocean utilities

combine_topo.CombineTopo(test_group)

A test case for combining GEBCO 2023 with BedMachineAntarctica topography datasets

combine_topo.Combine(test_case)

A step for combining GEBCO 2023 with BedMachineAntarctica topography datasets

combine_topo.Combine.setup()

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

combine_topo.Combine.run()

Run this step of the test case

cull_restarts.CullRestarts(test_group)

A test case for culling MPAS-Ocean and -Seaice restart files to exclude ice-shelf cavities

cull_restarts.Cull(test_case)

A step for culling MPAS-Ocean and -Seaice restart files to exclude ice-shelf cavities

cull_restarts.Cull.run()

Run this step of the test case

extrap_woa.ExtrapWoa(test_group)

A test case for first remapping a topography dataset to the WOA 2023 grid, then extrapolating the WOA23 data into missing ocean regions such as ice-shelf cavities, then extrapolating into grounded ice and land

extrap_woa.Combine(test_case)

A step for combining a January and an annual WOA 2023 climatology into a single file, where the January data is used where available and the annual in the deeper ocean where monthly data is not provided.

extrap_woa.Combine.setup()

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

extrap_woa.Combine.run()

Run this step of the test case

extrap_woa.ExtrapStep(test_case)

Extrapolate WOA 2023 data into missing ocean regions, then land and grounded ice

extrap_woa.ExtrapStep.setup()

Determine the output filename

extrap_woa.ExtrapStep.run()

Extrapolate WOA 2023 model temperature and salinity into ice-shelf cavities.

extrap_woa.RemapTopography(test_case)

A step for remapping bathymetry and ice-shelf topography from one latitude-longitude grid to another

extrap_woa.RemapTopography.setup()

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

extrap_woa.RemapTopography.constrain_resources(...)

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

extrap_woa.RemapTopography.run()

Run this step of the test case

ziso

Ziso(mpas_core)

A test group for Zonally Invariant Southern Ocean (ZISO) test cases

configure(name, resolution, config)

Modify the configuration options for this test case

ZisoTestCase(test_group, resolution, ...)

The default test case for the ZISO test group simply creates the mesh and initial condition, then performs a short forward run with analysis members but without frazil.

ZisoTestCase.configure()

Modify the configuration options for this test case.

ZisoTestCase.run()

This method is deprecated.

with_frazil.WithFrazil(test_group, resolution)

The with frazil test case for the ZISO test group simply creates the mesh and initial condition, then performs a short forward run including frazil formation.

with_frazil.WithFrazil.configure()

Modify the configuration options for this test case.

with_frazil.WithFrazil.run()

This method is deprecated.

forward.Forward(test_case, resolution[, ...])

A step for performing forward MPAS-Ocean runs as part of ZISO test cases.

forward.Forward.setup()

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

forward.Forward.run()

Run this step of the test case

initial_state.InitialState(test_case, ...)

A step for creating a mesh and initial condition for ZISO test cases

initial_state.InitialState.run()

Run this step of the test case

ocean framework

mesh.cull.CullMeshStep(test_case, ...[, ...])

A step for culling a global MPAS-Ocean mesh

mesh.cull.CullMeshStep.setup()

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

mesh.cull.CullMeshStep.run()

Run this step of the test case

mesh.cull.cull_mesh([with_cavities, ...])

First step of initializing the global ocean:

mesh.floodplain.FloodplainMeshStep(test_case)

A step for creating a global MPAS-Ocean mesh that includes variables needed for preserving a floodplain

mesh.floodplain.FloodplainMeshStep.run()

Run this step of the test case

mesh.remap_topography.RemapTopography(...[, ...])

A step for remapping bathymetry and ice-shelf topography from a latitude-longitude grid to a global MPAS-Ocean mesh

mesh.remap_topography.RemapTopography.setup()

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

mesh.remap_topography.RemapTopography.constrain_resources(...)

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

mesh.remap_topography.RemapTopography.run()

Run this step of the test case

haney.compute_haney_number(ds_mesh, ...[, ...])

Compute the Haney number rx1 for each edge, and interpolate it to cells

iceshelf.compute_land_ice_pressure_and_draft(...)

Compute the pressure from and overlying ice shelf and the ice-shelf draft

iceshelf.adjust_ssh(variable, ...[, ...])

Adjust the sea surface height or land-ice pressure to be dynamically consistent with one another.

particles.write(init_filename, ...[, types, ...])

Write an initial condition for particles partitioned across cores

particles.remap_particles(init_filename, ...)

Remap particles onto a new grid decomposition.

plot.plot_initial_state([input_file_name, ...])

creates histogram plots of the initial condition

plot.plot_vertical_grid(grid_filename, config)

Plot the vertical grid

vertical.init_vertical_coord(config, ds)

Create a vertical coordinate based on the config options in the vertical_grid section and the bottomDepth and ssh variables of the mesh data set.

vertical.grid_1d.generate_1d_grid(config)

Generate a vertical grid for a test case, using the config options in the vertical_grid section

vertical.grid_1d.write_1d_grid(interfaces, ...)

write the vertical grid to a file

vertical.partial_cells.alter_bottom_depth(...)

Alter bottomDepth and maxLevelCell for full or partial top cells, if requested

vertical.partial_cells.alter_ssh(config, ...)

Alter ssh and maxLevelCell for full or partial top cells, if requested

vertical.zlevel.init_z_level_vertical_coord(...)

Create a z-level vertical coordinate based on the config options in the vertical_grid section and the bottomDepth and ssh variables of the mesh data set.

vertical.zlevel.compute_min_max_level_cell(...)

Compute minLevelCell and maxLevelCell indices as well as a cell mask for the given reference grid and top and bottom topography.

vertical.zlevel.compute_z_level_layer_thickness(...)

Compute z-level layer thickness from ssh and bottomDepth

vertical.zlevel.compute_z_level_resting_thickness(...)

Compute z-level resting thickness by "unstretching" layerThickness based on ssh and bottomDepth

vertical.zstar.init_z_star_vertical_coord(...)

Create a z-star vertical coordinate based on the config options in the vertical_grid section and the bottomDepth and ssh variables of the mesh data set.