Merge branch 'feature/refactor' of github.com:ecmwf/anemoi-inference …

…into feature/refactor

docs/conf.py

@@ -121,6 +121,12 @@
 #
 html_theme = "sphinx_rtd_theme"
 
+# Make the page width match the browser width
+html_theme_options = {
+    "body_max_width": "none",
+}
+
+
 # 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".

docs/configs/forcings.rst

@@ -13,3 +13,29 @@ The example below shows an example where the forcings are fetched from
 ``mars`` while the initial conditions are fetched from ``test``.
 
 .. literalinclude:: forcings_1.yaml
+   :language: yaml
+
+This example above is a shortcut for:
+
+.. literalinclude:: forcings_2.yaml
+
+You can also specify different sources for each forcing.
+
+This is to get the initial constant forcings from a file:
+
+.. literalinclude:: forcings_3.yaml
+   :language: yaml
+
+Get the dynamic forcings from mars:
+
+.. literalinclude:: forcings_4.yaml
+   :language: yaml
+
+And the LAM boundary conditions from a mars as well:
+
+.. literalinclude:: forcings_5.yaml
+   :language: yaml
+
+In the case of the last three type of forcings, it they are not
+specified, the value of `forcings.input` will be used. It this value is
+not specified, the value of `input` will then be used.

docs/configs/forcings_2.yaml

@@ -0,0 +1,2 @@
+forcing:
+  input: mars

docs/configs/forcings_3.yaml

@@ -0,0 +1,3 @@
+forcing:
+  constant:
+    grib: constant.grib

docs/configs/forcings_4.yaml

@@ -0,0 +1,2 @@
+forcing:
+  dynamic: mars

docs/configs/forcings_5.yaml

@@ -0,0 +1,2 @@
+forcing:
+  boundary: mars

docs/index.rst

@@ -22,12 +22,14 @@ 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:`overview`
 -  :doc:`installing`
 
 .. toctree::
    :maxdepth: 1
    :hidden:
 
+   overview
    installing
 
 *********************
@@ -74,36 +76,6 @@ of the *Anemoi* packages.
    configs/outputs
    configs/forcings
 
-..
-   .. toctree::
-
-..
-   :maxdepth: 1
-
-..
-   :glob:
-
-..
-   :caption: Modules
-
-..
-   modules/*
-
-..
-   .. toctree::
-
-..
-   :maxdepth: 1
-
-..
-   :glob:
-
-..
-   :caption: Schemas
-
-..
-   schemas/*
-
 *****************
  Anemoi packages
 *****************

docs/overview.rst

@@ -0,0 +1,28 @@
+.. _overview:
+
+##########
+ Overview
+##########
+
+.. _data-flow:
+
+.. figure:: schemas/overview.png
+   :alt: Overview
+   :align: center
+   :target: javascript:void(window.open('_images/overview.png'))
+
+   Flow of data in inference.
+
+The schema above is a high-level overview of the data flow in the
+inference process (click on the image for a larger version).
+
+Several key concepts are introduced:
+
+-  Input:
+-  Prognostic variables:
+-  Diagnostic variables:
+-  Output:
+-  Constant forcings:
+-  Dynamic forcings:
+-  Computed constants:
+-  Computed forcings: