Huracan-project · stella-bourdin · Jan 9, 2025 · Nov 25, 2024 · Nov 25, 2024 · Nov 25, 2024
diff --git a/docs/api/assess.rst b/docs/api/assess.rst
@@ -1,3 +1,5 @@
+.. _api-assess:
+
 assess
 ======
 

diff --git a/docs/api/calc.rst b/docs/api/calc.rst
@@ -1,3 +1,5 @@
+.. _api-calc:
+
 calc
 ====
 

diff --git a/docs/api/huracanpy.rst b/docs/api/huracanpy.rst
@@ -1,3 +1,5 @@
+.. _api-core:
+
 huracanpy
 =========
 

diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -1,3 +1,5 @@
+.. _api-index:
+
 API
 ===
 

diff --git a/docs/api/info.rst b/docs/api/info.rst
@@ -1,3 +1,5 @@
+.. _api-info:
+
 info
 ====
 

diff --git a/docs/api/plot.rst b/docs/api/plot.rst
@@ -1,3 +1,5 @@
+.. _api-plot:
+
 plot
 ====
 

diff --git a/docs/api/tc.rst b/docs/api/tc.rst
@@ -1,3 +1,5 @@
+.. _api-tc:
+
 tc
 ==
 

diff --git a/docs/images/package_structure_flowchart/flowchart.png b/docs/images/package_structure_flowchart/flowchart.png
diff --git a/docs/images/package_structure_flowchart/flowchart.pptx b/docs/images/package_structure_flowchart/flowchart.pptx
diff --git a/docs/user_guide/accessor.ipynb b/docs/user_guide/accessor.ipynb
diff --git a/docs/user_guide/assess.ipynb b/docs/user_guide/assess.ipynb
diff --git a/docs/user_guide/calc.ipynb b/docs/user_guide/calc.ipynb
diff --git a/docs/user_guide/index.rst b/docs/user_guide/index.rst
@@ -15,21 +15,27 @@ We recommend you get familiar with xarray to make the most of this package (http
 Package structure
 -----------------
 
-The package has several module that allow you to:
+The package has several modules that allow you to:
 
-* Load cyclone tracks (`load`);
-* Add information to your tracks (`info`);
-* Subset (`subset`) and interpolate (`interp`) the tracks;
-* Compute standard diagnostic metrics  (`calc`);
-* Make simple plots (`plot`);
-* Compare several datasets between them (`assess`).
+* Load  and save cyclone tracks;
+* Subset and interpolate the tracks;
+* Add information to your tracks (:ref:`api-info`);
+* Compute standard diagnostic metrics (:ref:`api-calc`);
+* Make simple plots (:ref:`api-plot`);
+* Compare several datasets between them (:ref:`api-assess`).
 
-The flowchart below illustrates this structure. The present user guide details how to use each of these modules.
+It also module containing TC-specific functions (:ref:`api-tc`). 
+
+The flowchart below illustrates this structure. The functions in each module are listed in the :ref:`api-index`.
 
 .. image:: ../images/package_structure_flowchart/flowchart.png
   :width: 1000
   :alt: Alternative text
 
+xarray accessor
+~~~~~~~~~~~~~~~
+
+The package also defines a `.hrcn` xarray accessor, which allow you to call most of the functions as methods on the dataset itself. 
 
 
 .. toctree::
@@ -41,12 +47,6 @@ The flowchart below illustrates this structure. The present user guide details h
     demo
     load
     save
-    info
     subset
-    interp
-    calc
-    tc
-    plot
-    assess
-    speed
-    accessor
+..  hidden at the moment
+    speed