first commit

docs/Makefile

@@ -0,0 +1,22 @@
+#!/usr/bin/env make -f
+
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_static/style.css

@@ -0,0 +1,48 @@
+.wy-side-nav-search {
+    background-color: #f7f7f7;
+}
+
+/*There is a clash between xarray notebook styles and readthedoc*/
+
+.rst-content dl.xr-attrs dt {
+    all: revert;
+    font-size: 95%;
+    white-space: nowrap;
+}
+
+.rst-content dl.xr-attrs dd {
+    font-size: 95%;
+}
+
+.xr-wrap {
+    font-size: 85%;
+}
+
+.wy-table-responsive table td, .wy-table-responsive table th {
+    white-space: inherit;
+}
+
+/*
+.wy-table-responsive table td,
+.wy-table-responsive table th {
+    white-space: normal !important;
+    vertical-align: top !important;
+}
+
+.wy-table-responsive {
+    margin-bottom: 24px;
+    max-width: 100%;
+    overflow: visible;
+} */
+
+/* Hide notebooks warnings */
+.nboutput .stderr {
+    display: none;
+}
+
+/*
+Set logo size
+*/
+.wy-side-nav-search .wy-dropdown > a img.logo, .wy-side-nav-search > a img.logo {
+    width: 200px;
+}

docs/conf.py

@@ -0,0 +1,116 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import datetime
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath(".."))
+
+
+read_the_docs_build = os.environ.get("READTHEDOCS", None) == "True"
+
+# top = os.path.realpath(os.path.dirname(os.path.dirname(__file__)))
+# sys.path.insert(0, top)
+
+
+source_suffix = ".rst"
+master_doc = "index"
+pygments_style = "sphinx"
+html_theme_options = {"logo_only": True}
+html_logo = "_static/logo.png"
+
+
+# -- Project information -----------------------------------------------------
+
+project = "Anemoi"
+
+author = "ECMWF"
+
+year = datetime.datetime.now().year
+if year == 2024:
+    years = "2024"
+else:
+    years = "2024-%s" % (year,)
+
+copyright = "%s, ECMWF" % (years,)
+
+
+release = "0.1.0"
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.todo",
+    "sphinx_rtd_theme",
+    "nbsphinx",
+    "sphinx.ext.graphviz",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+# templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "'**.ipynb_checkpoints'"]
+
+intersphinx_mapping = {
+    "python": ("https://python.readthedocs.io/en/latest", None),
+    "anemoi-utils": (
+        "https://anemoi-utils.readthedocs.io/en/latest/",
+        ("../../anemoi-utils/docs/_build/html/objects.inv", None),
+    ),
+    "anemoi-datasets": (
+        "https://anemoi-datasets.readthedocs.io/en/latest/",
+        ("../../anemoi-datasets/docs/_build/html/objects.inv", None),
+    ),
+    "anemoi-models": (
+        "https://anemoi-models.readthedocs.io/en/latest/",
+        ("../../anemoi-models/docs/_build/html/objects.inv", None),
+    ),
+    "anemoi-training": (
+        "https://anemoi-training.readthedocs.io/en/latest/",
+        ("../../anemoi-training/docs/_build/html/objects.inv", None),
+    ),
+    "anemoi-inference": (
+        "https://anemoi-inference.readthedocs.io/en/latest/",
+        ("../../anemoi-inference/docs/_build/html/objects.inv", None),
+    ),
+}
+
+
+# https://www.notion.so/Deepnote-Launch-Buttons-63c642a5e875463495ed2341e83a4b2a
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
+html_css_files = ["style.css"]
+
+
+todo_include_todos = not read_the_docs_build

docs/index.rst

@@ -0,0 +1,49 @@
+.. _anemoi-utils:
+
+.. _index-page:
+
+####################################
+ 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.
+
+This package provides a series of utility functions for used by the rest
+of the *Anemoi* packages.
+
+-  :doc:`installing`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+   installing
+
+*****************
+ Anemoi packages
+*****************
+
+-  :ref:`anemoi-utils <anemoi-utils:index-page>`
+-  :ref:`anemoi-datasets <anemoi-datasets:index-page>`
+-  :ref:`anemoi-models <anemoi-models:index-page>`
+-  :ref:`anemoi-training <anemoi-training:index-page>`
+-  :ref:`anemoi-inference <anemoi-inference:index-page>`
+
+*********
+ License
+*********
+
+*Anemoi* is available under the open source `Apache License`__.
+
+.. __: http://www.apache.org/licenses/LICENSE-2.0.html

docs/installing.rst

@@ -0,0 +1,26 @@
+############
+ Installing
+############
+
+To install the package, you can use the following command:
+
+.. code:: bash
+
+   pip install anemoi-inference
+
+**************
+ Contributing
+**************
+
+.. code:: bash
+
+   git clone ...
+   cd anemoi-inference
+   pip install .[dev]
+   pip install -r docs/requirements.txt
+
+You may also have to install pandoc on MacOS:
+
+.. code:: bash
+
+   brew install pandoc

docs/requirements.txt

@@ -0,0 +1,9 @@
+# These are the requirements for readthedoc
+sphinx
+sphinx_rtd_theme
+nbsphinx
+
+# Also requires `brew install pandoc` on Mac
+pandoc
+
+rstfmt