Home

esgf drslib documentation

Drslib is a Python library for processing the 5th Climate Model Intercomparison Project (CMIP5) Data Reference Syntax (DRS). It includes API-level code for working with DRS components, algorithms for decuding DRS components from incomplete information and a command-line tool for manipulating data files into the recommended DRS directory structure.It has been developed by the Centre for Environmental Data Archival as part of the ESG Federation.

User Guide

• Introduction
  • Use Cases
  • Installation
    • Installing for development
  • Configuration
    • Overriding DRS vocabularies
  • Logging
  • Testing
  • Reporting Bugs
• drslib API HowTo
  • Parsing DRS filenames
  • Generating DRS paths and filenames
• drs_tool command-line interface
  • Concepts
  • Usage
  • An Example
• CMIP5 product detection
  • drs_tool configuration
  • The configuration file.
    • An Example
    • Option names
  • Invoking drs_tool with product detection

Reference

• Module Reference
  • drslib.drs — DRS objects and utilities
  • drslib.translate — Translate DRS filepaths
  • drslib.cmip5 — DRS objects and utilities
  • drslib.mip_table — Loading CMOR MIP Tables
  • drslib.drs_tree — Managing DRS directory structure versioning
  • drslib.p_cmip5 — CMIP5 product detection
    • Set-up
    • The cmip5_product class
    • The find_product method
    • Usage
    • Testing the p_cmip5 module: test_p_cmip5.py

Appendix

• Translating CMIP3 to CMIP5
  • Example
  • CMIP3 DRS components
    • Institute & Model
    • Experiment
    • Frequency
    • Modelling-realm
    • Variable name
    • Ensemble member
    • Subset and extended path

Indices and tables

• Index
• Module Index