docs: include creator and inspector to modules

ecmwf · Aug 21, 2024 · d68bbf1 · d68bbf1
1 parent bf38fe3
commit d68bbf1
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 2 deletions.
diff --git a/docs/graphs/node_attributes.rst b/docs/graphs/node_attributes.rst
@@ -1,4 +1,4 @@
-.. _node-attributes:
+.. _graphs-node_attributes:
 
 ####################
  Nodes - Attributes

diff --git a/docs/graphs/node_coordinates.rst b/docs/graphs/node_coordinates.rst
@@ -1,4 +1,4 @@
-.. _node-coordinates:
+.. _graphs-node_coordinates:
 
 #####################
  Nodes - Coordinates

diff --git a/docs/index.rst b/docs/index.rst
@@ -59,6 +59,8 @@ of the *Anemoi* packages.
 -  :doc:`modules/edge_builder`
 -  :doc:`modules/node_attributes`
 -  :doc:`modules/edge_attributes`
+-  :doc:`modules/graph_creator`
+-  :doc:`modules/graph_inspector`
 
 .. toctree::
    :maxdepth: 1
@@ -69,6 +71,8 @@ of the *Anemoi* packages.
    modules/edge_builder
    modules/node_attributes
    modules/edge_attributes
+   modules/graph_creator
+   modules/graph_inspector
 
 *******************
  Command line tool

diff --git a/docs/modules/graph_creator.rst b/docs/modules/graph_creator.rst
@@ -0,0 +1,14 @@
+.. _modules-graph_creator:
+
+###############
+ Graph Creator
+###############
+
+This module is used to create custom graphs for data-driven weather
+models. The graphs are built using a `recipe` that defines the structure
+of the graph.
+
+.. automodule:: anemoi.graphs.create
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
diff --git a/docs/modules/graph_inspector.rst b/docs/modules/graph_inspector.rst
@@ -0,0 +1,17 @@
+.. _modules-graph_inspector:
+
+#################
+ Graph Inspector
+#################
+
+This module is used to inspect graphs. This inspection includes:
+
+-  Distribution plots of node & edge attributes.
+-  Interactive plot of each subgraph.
+-  Interactive plot of isolated nodes.
+-  Description of the graph in the console.
+
+.. automodule:: anemoi.graphs.create
+   :members:
+   :no-undoc-members:
+   :show-inheritance: