docs: adding edges to tables

ecmwf · Sep 16, 2024 · 0f5bfb1 · 0f5bfb1
1 parent 0deac2e
commit 0f5bfb1
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 0 deletions.
diff --git a/docs/graphs/edges/multi_scale.rst b/docs/graphs/edges/multi_scale.rst
@@ -28,6 +28,10 @@ refinement level to be considered neighbours, and then connected.
    This method is used by data-driven weather models like GraphCast to
    process the latent/hidden state.
 
+.. csv-table:: Triangular refinements specifications (x_hops=1)
+   :file: ./tri_refined_edges.csv
+   :header-rows: 1
+
 .. warning::
 
    This connection method is only support for building the connections

diff --git a/docs/graphs/edges/tri_refined_edges.csv b/docs/graphs/edges/tri_refined_edges.csv
@@ -0,0 +1,8 @@
+Refinement,Num Nodes,Num Edges,Num Multilevel Edges
+0,12,60,60
+1,42,240,300
+2,162,960,1260
+3,642,3840,5100
+4,2562,15360,20460
+5,10242,61440,81900
+6,40962,245760,327660
diff --git a/docs/graphs/node_coordinates/tri_nodes.csv b/docs/graphs/node_coordinates/tri_nodes.csv
@@ -0,0 +1,8 @@
+Refinement,Num Nodes,Num Faces,Avg. Area (sq km)
+0,12,20,25503600
+1,42,80,6375900
+2,162,320,1593975
+3,642,1280,398494
+4,2562,5120,99623
+5,10242,20480,24905
+6,40962,81920,6226
diff --git a/docs/graphs/node_coordinates/tri_refined_icosahedron.rst b/docs/graphs/node_coordinates/tri_refined_icosahedron.rst
@@ -72,6 +72,10 @@ where `resolution` argument is dropped divided into `global_resolution`
 and `lam_resolution`, which are the number of refinements to be applied
 to the icosahedron outside and inside the area of interest respectively.
 
+.. csv-table:: Triangular refinements specifications
+   :file: ./tri_nodes.csv
+   :header-rows: 1
+
 .. warning::
 
    This class will require the `trimesh <https://trimesh.org>`_ package