Internal API documentation

Warning

The information in this section only pertains to the development and maintenance of the MDTF framework code. It’s not needed for end users to run the package, or for POD developers to develop new diagnostics.

Package design

These sections describe design features of the code that cut across multiple modules.

• General design principles
• General code style
• Plugin system and site-specific code
• Object hierarchy
• Metadata schema
• Provenance and logging

Package code and API documentation

These sections provide an overview of specific parts of the code that’s more higher-level than the module docstrings.

• Framework configuration and parsing
• Data layer: Overview
• Data layer: Query
• Data layer: Fetch
• Data layer: Preprocessing
• util subpackage