index.rst

Welcome to CliMetLab's documentation!

Warning

This documentation is work in progress. It is not yet ready.

CliMetLab is a Python package aiming at simplifying access to climate and meteorological datasets, allowing users to focus on science instead of technical issues such as data access and data formats. It is mostly intended to be used in Jupyter notebooks, and be interoperable with all popular data analytic packages, such as NumPy, Pandas, Xarray, SciPy, Matplotlib, etc. as well as machine learning frameworks, such as TensorFlow, Keras or PyTorch. See overview for more information.

Documentation

• overview
• installing
• firststeps
• examples

overview installing firststeps examples

User Guide (TODO)

• guide/howtos
• guide/datasets
• guide/sources
• guide/data_handling
• guide/mltools
• guide/plotting
• guide/caching
• guide/settings
• guide/dask
• guide/pluginlist
• guide/cmdline

guide/howtos guide/datasets guide/sources guide/data_handling guide/mltools guide/plotting guide/caching guide/settings guide/dask guide/pluginlist guide/cmdline

Plugin Developer Guide

• contributing/overview
• contributing/datasets
• contributing/datasets_yaml
• contributing/sources
• contributing/normalize
• contributing/availability
• contributing/alias_argument
• contributing/grib
• contributing/plotting

contributing/overview contributing/datasets contributing/datasets_yaml contributing/sources contributing/normalize contributing/availability contributing/alias_argument contributing/grib contributing/plotting

CliMetLab Developer Guide

• developer/overview
• developer/todolist
• developer/architecture
• developer/plotting
• developer/gallery
• developer/plugins

developer/overview developer/todolist developer/architecture developer/plotting developer/gallery developer/plugins

License

CliMetLab is available under the open source Apache License.