Skip to content

Latest commit

 

History

History
132 lines (104 loc) · 3.07 KB

index.rst

File metadata and controls

132 lines (104 loc) · 3.07 KB
Raw

Welcome to Anemoi's documentation!

Warning

This documentation is work in progress.

Anemoi is a framework for developing machine learning weather forecasting models. It comprises of components or packages for preparing training datasets, conducting ML model training and a registry for datasets and trained models. Anemoi provides tools for operational inference, including interfacing to verification software. As a framework it seeks to handle many of the complexities that meteorological organisations will share, allowing them to easily train models from existing recipes but with their own data.

An Anemoi dataset is a thin wrapper around a zarr store that is optimised for training data-driven weather forecasting models. It is organised in such a way that I/O operations are minimised.

This documentation is divided into two main sections: how to use existing datasets <using-introduction> and how to build new datasets <building-introduction>.

  • overview
  • installing

overview installing

Using training datasets

  • using/introduction
  • using/opening
  • using/methods
  • using/subsetting
  • using/combining
  • using/selecting
  • using/grids
  • using/statistics
  • using/other
  • using/matching
  • using/miscellaneous
  • using/configuration

using/introduction using/opening using/methods using/subsetting using/combining using/selecting using/grids using/statistics using/other using/matching using/miscellaneous using/configuration

Building training datasets

  • building/introduction
  • building/operations
  • building/sources
  • building/filters
  • building/statistics

building/introduction building/operations building/sources building/filters building/naming-variables building/handling-missing-dates building/handling-missing-values building/statistics

Command line tool

  • cli/introduction
  • cli/create
  • cli/inspect
  • cli/compare
  • cli/copy

cli/introduction cli/create cli/inspect cli/compare cli/copy

Anemoi packages

  • anemoi-utils <anemoi-utils:index-page>
  • anemoi-datasets <anemoi-datasets:index-page>
  • anemoi-models <anemoi-models:index-page>
  • anemoi-training <anemoi-training:index-page>
  • anemoi-inference <anemoi-inference:index-page>

License

Anemoi is available under the open source Apache License.