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: mpas_analysis¶
|
Entry point for the main script |
|
Build a list of analysis tasks. |
|
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. |
|
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. |
|
Update the ‘generate’ config option using a string from the command line. |
|
Run all the tasks, either in serial or in parallel |
|
Build a list of analysis modules based on the ‘generate’ config option. |
Downloading data¶
Entry point for downloading the input data set from public repository for MPAS-Analysis to work. |
Analysis tasks¶
Base Class¶
|
The base class for analysis tasks. |
Perform steps to set up the analysis (e.g. |
|
Run the analysis. |
|
|
Only run this task after the given task has completed. |
|
Add a subtask to this tasks. |
|
Sets up logging and then runs the analysis task. |
Determines if this analysis should be generated, based on the |
|
Check to make sure a given analysis is turned on, issuing a warning or raising an exception if not. |
|
|
Set the start and end dates in the |
Ocean tasks¶
|
An analysis task for comparison of sea surface temperature (sst) against observations |
|
An analysis task for comparison of sea surface salinity (sss) against observations |
|
An analysis task for comparison of mixed layer depth (mld) against observations |
|
An analysis task for comparison of mixed layer depth (mld) against observations |
|
An analysis task for comparison of sea surface height (ssh) against observations |
|
An analysis task for comparison of eddy kinetic energy (eke) against observations |
|
An analysis task for comparison of the anomaly from a reference year (typically the start of the simulation) of ocean heat content (OHC) |
|
An analysis task for comparison of Antarctic melt rates against observations |
|
An analysis task for comparison of antarctic field against the Southern Ocean State Estimate |
|
An analysis task for comparison of potential temperature against Argo observations |
|
An analysis task for comparison of global salinity against Argo observations |
|
A task for computing and plotting time series and spectra of the El Nino 3.4 climate index |
|
Plot meridional heat transport from the analysis member output. |
|
Computation and plotting of model meridional overturning circulation. |
|
Performs analysis of ocean heat content (OHC) from time-series output. |
|
Performs analysis of time series of potential temperature anomalies from a reference simulation year as a function of depth. |
|
Performs analysis of time series of salinity anomalies from the first simulation year as a function of depth. |
|
Performs analysis of the time-series output of sea-surface temperature (SST). |
|
Performs analysis of the time-series output of Antarctic sub-ice-shelf melt rates. |
|
Performs analysis of the time-series output of regionoal mean temperature, salinity, etc. |
|
Extract and plot time series of transport through transects on the MPAS mesh. |
|
A subtask for computing anomalies of moving averages and writing them out. |
|
An analysis task for plotting 2D model fields against observations. |
Store attributes related to plots, plot file names and HTML output. |
Plots a time series, summed or averaged over various depth ranges |
|
Plots a time series vs. |
Sea ice tasks¶
|
An analysis task for comparison of sea ice concentration against observations |
|
An analysis task for comparison of sea ice thickness against observations |
|
Performs analysis of time series of sea-ice properties. |
|
An analysis task for comparison of iceberg concentration against observations |
|
An analysis task for plotting 2D model fields against observations or a control run. |
Store attributes related to plots, plot file names and HTML output. |
Configuration¶
Get an option, using the supplied default value if the option is not present. |
|
Get an option as an expression (typically a list, though tuples and dicts are also available). |