API reference¶
This page provides an auto-generated summary of the MPAS-Analysis API. For more details and examples, refer to the relevant chapters in the main part of the documentation.
Top-level script: run_mpas_analysis¶
run_mpas_analysis.build_analysis_list (…) |
Build a list of analysis tasks. |
run_mpas_analysis.determine_analyses_to_generate (…) |
Build a list of analysis tasks to run based on the ‘generate’ config option (or command-line flag) and prerequisites and subtasks of each requested task. |
run_mpas_analysis.add_task_and_subtasks (…) |
If a task has been requested through the generate config option or if it is a prerequisite of a requested task, add it to the dictionary of tasks to generate. |
run_mpas_analysis.update_generate (config, …) |
Update the ‘generate’ config option using a string from the command line. |
run_mpas_analysis.run_analysis (config, analyses) |
Run all the tasks, either in serial or in parallel |
run_mpas_analysis.wait_for_task (runningTasks) |
Build a list of analysis modules based on the ‘generate’ config option. |
Analysis tasks¶
Base Class¶
AnalysisTask (config, taskName, componentName) |
The base class for analysis tasks. |
AnalysisTask.setup_and_check () |
Perform steps to set up the analysis (e.g. |
AnalysisTask.run_task () |
Run the analysis. |
AnalysisTask.run_after (task) |
Only run this task after the given task has completed. |
AnalysisTask.add_subtask (subtask) |
Add a subtask to this tasks. |
AnalysisTask.run ([writeLogFile]) |
Sets up logging and then runs the analysis task. |
AnalysisTask.check_generate () |
Determines if this analysis should be generated, based on the generate config option and taskName , componentName and tags . |
AnalysisTask.check_analysis_enabled (…[, …]) |
Check to make sure a given analysis is turned on, issuing a warning or raising an exception if not. |
AnalysisTask.set_start_end_date (section) |
Set the start and end dates in the config correspond to the start and end years in a given category of analysis |
Ocean tasks¶
ClimatologyMapSST (config, mpasClimatologyTask) |
An analysis task for comparison of sea surface temperature (sst) against observations |
ClimatologyMapSSS (config, mpasClimatologyTask) |
An analysis task for comparison of sea surface salinity (sss) against observations |
ClimatologyMapMLD (config, mpasClimatologyTask) |
An analysis task for comparison of mixed layer depth (mld) against observations |
ClimatologyMapSSH (config, mpasClimatologyTask) |
An analysis task for comparison of sea surface height (ssh) against observations |
ClimatologyMapOHCAnomaly (config, …[, …]) |
An analysis task for comparison of the anomaly from a reference year (typically the start of the simulation) of ocean heat content (OHC) |
ClimatologyMapAntarcticMelt (config, …[, …]) |
An analysis task for comparison of Antarctic melt rates against observations |
ClimatologyMapSoseTemperature (config, …[, …]) |
An analysis task for comparison of antarctic temperature against SOSE fields |
ClimatologyMapSoseSalinity (config, …[, …]) |
An analysis task for comparison of antarctic salinity against SOSE fields |
ClimatologyMapSoseMLD (config, …[, refConfig]) |
An analysis task for comparison of antarctic mixed layer depth against SOSE fields |
ClimatologyMapSoseZonalVel (config, …[, …]) |
An analysis task for comparison of zonal velociy around Antarctica against SOSE fields |
ClimatologyMapSoseMeridVel (config, …[, …]) |
An analysis task for comparison of meridional velociy around Antarctica against SOSE fields |
ClimatologyMapSoseVelMag (config, …[, …]) |
An analysis task for comparison of velocity magnitude around Antarctica against SOSE fields |
ClimatologyMapArgoTemperature (config, …[, …]) |
An analysis task for comparison of antarctic temperature against SOSE fields |
ClimatologyMapArgoSalinity (config, …[, …]) |
An analysis task for comparison of Global Temperature against Argo fields |
IndexNino34 (config, mpasTimeSeriesTask[, …]) |
A task for computing and plotting time series and spectra of the El Nino 3.4 climate index |
MeridionalHeatTransport (config, …[, refConfig]) |
Plot meridional heat transport from the analysis member output. |
StreamfunctionMOC (config, mpasClimatologyTask) |
Computation and plotting of model meridional overturning circulation. |
TimeSeriesOHCAnomaly (config, mpasTimeSeriesTask) |
Performs analysis of ocean heat content (OHC) from time-series output. |
TimeSeriesTemperatureAnomaly (config, …) |
Performs analysis of time series of temperature anomalies from the first simulation year as a function of depth. |
TimeSeriesSalinityAnomaly (config, …) |
Performs analysis of time series of salinity anomalies from the first simulation year as a function of depth. |
TimeSeriesSST (config, mpasTimeSeriesTask[, …]) |
Performs analysis of the time-series output of sea-surface temperature (SST). |
TimeSeriesAntarcticMelt (config, …[, refConfig]) |
Performs analysis of the time-series output of Antarctic sub-ice-shelf melt rates. |
ComputeAnomalySubtask (parentTask, …[, …]) |
A subtask for computing anomalies of moving averages and writing them out. |
PlotClimatologyMapSubtask (parentTask, …[, …]) |
An analysis task for plotting 2D model fields against observations. |
PlotClimatologyMapSubtask.set_plot_info (…) |
Store attributes related to plots, plot file names and HTML output. |
PlotDepthIntegratedTimeSeriesSubtask (…[, …]) |
Plots a time series, summed or averaged over various depth ranges |
PlotHovmollerSubtask (parentTask, regionName, …) |
Plots a time series vs. |
Sea ice tasks¶
ClimatologyMapSeaIceConc (config, …[, …]) |
An analysis task for comparison of sea ice concentration against observations |
ClimatologyMapSeaIceThick (config, …[, …]) |
An analysis task for comparison of sea ice thickness against observations |
TimeSeriesSeaIce (config, mpasTimeSeriesTask) |
Performs analysis of time series of sea-ice properties. |
PlotClimatologyMapSubtask (parentTask, …[, …]) |
An analysis task for plotting 2D model fields against observations or a reference run. |
PlotClimatologyMapSubtask.set_plot_info (…) |
Store attributes related to plots, plot file names and HTML output. |
Configuration¶
MpasAnalysisConfigParser ([defaults, …]) |
|
MpasAnalysisConfigParser.getWithDefault (…) |
Get an option, using the supplied default value if the option is not present. |
MpasAnalysisConfigParser.getExpression (…) |
Get an option as an expression (typically a list, though tuples and dicts are also availabe). |