src package¶

Subpackages¶

  • src.tests package
    • Submodules
      • src.tests.shared_test_utils module
      • src.tests.test_cli module
      • src.tests.test_cmip6 module
      • src.tests.test_core module
      • src.tests.test_data_manager module
      • src.tests.test_diagnostic module
      • src.tests.test_environment_manager module
      • src.tests.test_mdtf module
      • src.tests.test_units module
    • Module contents
  • src.util package
    • Subpackages
      • src.util.tests package
        • Submodules
        • Module contents
    • Submodules
      • src.util.basic module
      • src.util.dataclass module
      • src.util.datelabel module
      • src.util.exceptions module
      • src.util.filesystem module
      • src.util.logs module
      • src.util.processes module
    • Module contents

Submodules¶

  • src.cli module
  • src.cmip6 module
  • src.conflict_resolution module
  • src.core module
  • src.data_manager module
  • src.data_model module
  • src.data_sources module
  • src.diagnostic module
  • src.environment_manager module
  • src.install module
  • src.mdtf_info module
  • src.output_manager module
  • src.preprocessor module
  • src.units module
  • src.verify_links module
  • src.xr_parser module

Module contents¶

MDTF Diagnostics

Navigation

  • Getting started
    • 1. Overview
    • 2. Installation instructions
    • 3. Running the package on your data
  • Framework reference
    • Command-line options
    • Model data sources
    • Conventions for variable names and units
    • Model data format
    • Runtime configuration
  • Diagnostics reference
    • Summary of MDTF process-oriented diagnostics
    • Example Diagnostic Documentation
    • Convective Transition Diagnostic Package
    • EOF of Geopotential Height Diagnostic Module From NCAR
    • MJO Propagation and Amplitude Diagnostic Package
    • MJO Suite Diagnostic Module From NCAR
    • MJO Teleconnection Diagnostic Package
    • Phase and Amplitude of Precipitation Diurnal Cycle
    • Soil moisture-Evapotranspiration Coupling Diagnostic Package
    • 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
  • Developer reference
    • Diagnostic settings file format
    • MDTF Environment variables
  • Internal framework code
    • Internal API documentation

  • Getting Started [PDF]
  • Developer's Walkthough [PDF]
  • Full documentation [PDF]

Related Topics

  • Documentation overview

Quick search

©2021, Model Diagnostics Task Force. | Powered by Sphinx 3.1.2 & Alabaster 0.7.12 | Page source