add dependency graph

docs/conf.py

@@ -97,6 +97,10 @@
         "https://anemoi-registry.readthedocs.io/en/latest/",
         ("../../anemoi-registry/docs/_build/html/objects.inv", None),
     ),
+    "anemoi-transform": (
+        "https://anemoi-transform.readthedocs.io/en/latest/",
+        ("../../anemoi-transform/docs/_build/html/objects.inv", None),
+    ),
 }
 
 

docs/index.rst

@@ -2,11 +2,6 @@
  Welcome to Anemoi's documentation!
 ####################################
 
-.. warning::
-
-   This documentation is work in progress. It is not yet ready.
-   Currently, the documentation is based on the one from the ecml-tools_
-   project, which will be merged into Anemoi.
 
 *Anemoi* is a framework for developing machine learning weather
 forecasting models. It comprises of components or packages for preparing
@@ -35,13 +30,17 @@ models from existing recipes but with their own data.
  Anemoi packages
 *****************
 
--  :ref:`anemoi-utils <anemoi-utils:index-page>`
+.. image:: schemas/dependencies.svg
+   :align: center
+
 -  :ref:`anemoi-datasets <anemoi-datasets:index-page>`
--  :ref:`anemoi-models <anemoi-models:index-page>`
 -  :ref:`anemoi-graphs <anemoi-graphs:index-page>`
--  :ref:`anemoi-training <anemoi-training:index-page>`
 -  :ref:`anemoi-inference <anemoi-inference:index-page>`
+-  :ref:`anemoi-models <anemoi-models:index-page>`
 -  :ref:`anemoi-registry <anemoi-registry:index-page>`
+-  :ref:`anemoi-training <anemoi-training:index-page>`
+-  :ref:`anemoi-transform <anemoi-transform:index-page>`
+-  :ref:`anemoi-utils <anemoi-utils:index-page>`
 
 *********
  License

docs/schemas/Makefile

@@ -0,0 +1,2 @@
+dependencies.svg: dependencies.dot Makefile
+	dot -o dependencies.svg -Tsvg dependencies.dot

docs/schemas/dependencies.dot

@@ -1,27 +1,39 @@
 digraph {
 
+    rankdir=BT;
+    splines="polyline";
+
     node [shape=record, fontname=Arial, fontsize=10,
         style=filled, color=lightblue];
     edge [fontname=Arial, fontsize=10];
 
+    datasets [URL="https://anemoi-datasets.readthedocs.io/en/latest/"];
+    graphs [URL="https://anemoi-graphs.readthedocs.io/en/latest/"];
+    inference [URL="https://anemoi-inference.readthedocs.io/en/latest/"];
+    models [URL="https://anemoi-models.readthedocs.io/en/latest/"];
+    registry [URL="https://anemoi-registry.readthedocs.io/en/latest/"];
+    training [URL="https://anemoi-training.readthedocs.io/en/latest/"];
+    transform [URL="https://anemoi-transform.readthedocs.io/en/latest/"];
+    utils [URL="https://anemoi-utils.readthedocs.io/en/latest/"];
+
 
-    "anemoi-datasets" -> "anemoi-utils";
-    "anemoi-graphs" -> "anemoi-datasets" [style=dashed];
-    "anemoi-inference" -> "anemoi-datasets" [style=dashed];
-    "anemoi-inference" -> "anemoi-models";
-    "anemoi-inference" -> "anemoi-transform";
-    "anemoi-models" -> "anemoi-utils";
-    "anemoi-registry" -> "anemoi-datasets" [style=dashed];
-    // "anemoi-registry" -> "anemoi-transform" [style=dashed];
-    "anemoi-registry" -> "anemoi-utils";
-    "anemoi-training" -> "anemoi-datasets";
-    "anemoi-training" -> "anemoi-graphs";
-    "anemoi-transform" -> "anemoi-utils";
-    // "anemoi-graphs" -> "anemoi-utils";
-    // "anemoi-inference" -> "anemoi-utils";
-    "anemoi-training" -> "anemoi-models";
-    // "anemoi-training" -> "anemoi-utils";
-    // "anemoi-web" -> "anemoi-datasets";
-    // "anemoi-web" -> "anemoi-inference";
+    datasets -> utils;
+    graphs -> datasets [style=dashed];
+    inference -> datasets [style=dashed];
+    inference -> models;
+    inference -> transform;
+    models -> utils;
+    registry -> datasets [style=dashed];
+    // registry -> transform [style=dashed];
+    registry -> utils;
+    training -> datasets;
+    training -> graphs;
+    transform -> utils;
+    // graphs -> utils;
+    // inference -> utils;
+    training -> models;
+    // training -> utils;
+    // "web" -> datasets;
+    // "web" -> inference;
 
 }