Welcome to the documentation for the MDTF-diagnostics Package

This site contains documentation for the MDTF-Diagnostics package. The code is fully open-source and hosted on GitHub.

• Getting started
  • 1. Overview
  • 2. Installation instructions
  • 3. Running the package on your data
  • 4. Running the MDTF-diagnostics package in “multirun” mode
• Developer information
  • 1. POD requirements
  • 2. Developer installation instructions
  • 3. POD development guidelines
  • 4. POD settings file summary
  • 5. POD coding best practices
  • 6. Git-based development workflow
  • 7. Development Cheatsheet
• Framework reference
  • Command-line options
  • Recognized conventions
  • Working with unimplemented conventions
  • Model data format
  • MDTF-diagnostics Environment variables
  • Running Submodules
• Internal code documentation
  • Package code and API documentation
  • Module index
• Tools documentation
  • catalog_builder.py
  • rename_input_files.py

Acknowledgements

Development of this code framework for process-oriented diagnostics was supported by the National Oceanic and Atmospheric Administration (NOAA) Climate Program Office Modeling, Analysis, Predictions and Projections (MAPP) Program (grant # NA18OAR4310280). Additional support was provided by University of California Los Angeles, the Geophysical Fluid Dynamics Laboratory, the National Center for Atmospheric Research, Colorado State University, Lawrence Livermore National Laboratory and the US Department of Energy.

Many of the process-oriented diagnostics modules (PODs) were contributed by members of the NOAA Model Diagnostics Task Force under MAPP support. Statements, findings or recommendations in these documents do not necessarily reflect the views of NOAA or the US Department of Commerce.

Indices and tables

• Index

• Search Page