Framework reference
¶
Command-line options
Running the package
Usage
Command-line options
POD-specific options
Model data sources
Sample model data source
Explicit file data source
CMIP6 local file data source
No preprocessor
Conventions for variable names and units
Recognized conventions
Working with unimplemented conventions
Model data format
Model data format requirements
xarray reference implementation
Runtime configuration
Environment managers
Runtime managers
Diagnostic settings file format
Brief summary of JSON
File organization
Settings section
Data section
Dimensions section
Varlist section
MDTF Environment variables
Overview
Paths
Model run information
Locations of model data files
Names of variables and dimensions
Simple example
More complex example
MDTF Diagnostics
Navigation
Getting started
1. Overview
2. Installation instructions
3. Running the package on your data
4. Running the MDTF-diagnostics package in “multirun” mode
Framework reference
Command-line options
Model data sources
Conventions for variable names and units
Model data format
Runtime configuration
Diagnostic settings file format
MDTF Environment variables
Diagnostics reference
Example Diagnostic Documentation
Rich Neale’s Blocking Diagnostic Documentation
Convective Transition Diagnostic Package
Moist Static Energy Diagnostic Package
Rossby Wave Sources Diagnostic Package
EOF of Geopotential Height Diagnostic Module From NCAR
Eulerian Storm Track
Multi-Case Example Diagnostic Documentation
Mixed layer depth
MJO Propagation and Amplitude Diagnostic Package
MJO Suite Diagnostic Module From NCAR
MJO Teleconnection Diagnostic Package
Ocean Surface Latent Heat Flux Diagnostic Documentation
Precipitation Buoyancy Diagnostic Package
Phase and Amplitude of Precipitation Diurnal Cycle
Sea Ice Suite
Soil moisture-Evapotranspiration Coupling Diagnostic Package
Stratosphere-Troposphere Coupling: Annular Modes
Stratosphere-Troposphere Coupling: Eddy Heat Fluxes
Stratosphere-Troposphere Coupling: Stratospheric Ozone and Circulation
Stratosphere-Troposphere Coupling: Stratospheric Polar Vortex Extremes
Stratosphere-Troposphere Coupling: Vertical Wave Coupling
TC MSE Variance Budget Analysis
TC Rain Rate Azimuthal Average Documentation
Surface Temperature Extremes and Distribution Shape Package
Top-Heaviness Metric Diagnostic Documentation
Tropical Pacific Sea Level Diagnostic Documentation
Wavenumber Frequency Spectra Diagnostic Module From NCAR
Site-specific documentation
Customizing your installation with the ‘local’ site
GFDL-specific information
Developer information
1. Introduction for POD developers
2. Migration from framework v2.0
3. POD development checklist
4. Developer quickstart guide
5. POD development guidelines
6. POD settings file summary
7. Walkthrough of framework operation
8. POD coding best practices
9. Git-based development workflow
Tools documentation
catalog_builder.py
rename_input_files.py
Internal code documentation
Package code and API documentation
Module index
Full documentation [PDF]
Related Topics
Documentation overview
Previous:
4.
Running the MDTF-diagnostics package in “multirun” mode
Next:
Command-line options
Quick search