Improve a bit the docs

dataforgoodfr · Jun 27, 2024 · c8d75ea · c8d75ea
1 parent e9e92c5
commit c8d75ea
Show file tree

Hide file tree

Showing 28 changed files with 116 additions and 235 deletions.
diff --git a/notebooks/datascience/sun_model_2_params.csv → data/silver/sun_model_2_params.csv b/notebooks/datascience/sun_model_2_params.csv → data/silver/sun_model_2_params.csv
diff --git a/...books/datascience/wind_model_2_params.csv → data/silver/wind_model_2_params.csv b/...books/datascience/wind_model_2_params.csv → data/silver/wind_model_2_params.csv
diff --git a/doc/getting_started/index.rst b/doc/getting_started/index.rst
@@ -3,13 +3,34 @@ Getting Started
 
 Installation
 ------------
+You can install the package from the source code by cloning the repository and
+using
+`Hatch <https://hatch.pypa.io/latest/>`_ to install the package.
 
+.. code-block:: bash
 
-Use Hatch to install the package.
+    git clone https://github.com/GreenForecast-Squad/energetic-stress-production
+    pipx install hatch
+    cd energy-forecast
+    hatch shell
 
+This will open a new shell with the hatch environment and the package installed
 
-Examples of use
-===============
 
-See the tutorials in the
-:doc:`../user_guide/index` !
+Running the dashboard
+---------------------
+
+To launche the vizual interface, run the dashboard with the following command:
+
+.. code-block:: bash
+
+    hatch run serve:prod
+
+With will launch a Streamlit app on the port ``8502`` of ``localhost``.
+You can access the app by opening a browser and going to the following URL: http://localhost:8502/energy_forecast .
+
+
+Detailed use cases
+==================
+
+To see move detailed use cases, you can check the tutorials in the :doc:`../user_guide/index` !
diff --git a/doc/src/energy_forecast.dashboard.dashboard.rst b/doc/src/energy_forecast.dashboard.dashboard.rst
diff --git a/doc/src/energy_forecast.dashboard.dashboard_streamlit.rst b/doc/src/energy_forecast.dashboard.dashboard_streamlit.rst
@@ -0,0 +1,7 @@
+energy\_forecast.dashboard.dashboard\_streamlit module
+======================================================
+
+.. automodule:: energy_forecast.dashboard.dashboard_streamlit
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/src/energy_forecast.dashboard.pages.1_weather.rst b/doc/src/energy_forecast.dashboard.pages.1_weather.rst
@@ -0,0 +1,7 @@
+energy\_forecast.dashboard.pages.1\_weather module
+==================================================
+
+.. automodule:: energy_forecast.dashboard.pages.1_weather
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/src/energy_forecast.dashboard.pages.2_power_generation.rst b/doc/src/energy_forecast.dashboard.pages.2_power_generation.rst
@@ -0,0 +1,7 @@
+energy\_forecast.dashboard.pages.2\_power\_generation module
+============================================================
+
+.. automodule:: energy_forecast.dashboard.pages.2_power_generation
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/src/energy_forecast.dashboard.pages.3_consumption_prediction.rst b/doc/src/energy_forecast.dashboard.pages.3_consumption_prediction.rst
@@ -0,0 +1,7 @@
+energy\_forecast.dashboard.pages.3\_consumption\_prediction module
+==================================================================
+
+.. automodule:: energy_forecast.dashboard.pages.3_consumption_prediction
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/src/energy_forecast.dashboard.pages.4_prediction_tempo.rst b/doc/src/energy_forecast.dashboard.pages.4_prediction_tempo.rst
@@ -0,0 +1,7 @@
+energy\_forecast.dashboard.pages.4\_prediction\_tempo module
+============================================================
+
+.. automodule:: energy_forecast.dashboard.pages.4_prediction_tempo
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/src/energy_forecast.dashboard.pages.rst b/doc/src/energy_forecast.dashboard.pages.rst
@@ -0,0 +1,21 @@
+energy\_forecast.dashboard.pages package
+========================================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   energy_forecast.dashboard.pages.1_weather
+   energy_forecast.dashboard.pages.2_power_generation
+   energy_forecast.dashboard.pages.3_consumption_prediction
+   energy_forecast.dashboard.pages.4_prediction_tempo
+
+Module contents
+---------------
+
+.. automodule:: energy_forecast.dashboard.pages
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/src/energy_forecast.dashboard.rst b/doc/src/energy_forecast.dashboard.rst
@@ -7,7 +7,8 @@ Submodules
 .. toctree::
    :maxdepth: 4
 
-   energy_forecast.dashboard.dashboard
+   energy_forecast.dashboard.dashboard_streamlit
+   energy_forecast.dashboard.pages
 
 Module contents
 ---------------

diff --git a/doc/src/energy_forecast.rst b/doc/src/energy_forecast.rst
@@ -20,6 +20,7 @@ Submodules
    energy_forecast.meteo
    energy_forecast.production_forecast
 
+
 Module contents
 ---------------
 

diff --git a/doc/src/modules.rst b/doc/src/modules.rst
@@ -1,7 +1,12 @@
 API reference
 =============
 
+The reference guide contains a detailed description of the functions and classes in the project.
+
+It is mainly intended for developers who want to understand how the methods work and which parameters can be used.
+It assumes that you have an understanding of the key concepts.
+
 .. toctree::
-   :maxdepth: 4
+   :maxdepth: 3
 
    energy_forecast
diff --git a/doc/user_guide/index.rst b/doc/user_guide/index.rst
@@ -6,8 +6,14 @@ Check the notebooks below to get started
 on specific topics, or head over to the :doc:`../src/modules` for a complete overview
 of the package.
 
+
 .. toctree::
-    :maxdepth: 3
+    :maxdepth: 1
     :caption: Common use cases
 
-    notebooks/index
+    notebooks/0_concat_all_tempo
+    notebooks/0_transform_data_RTE
+    notebooks/2_eolen_prediction
+    notebooks/3_PV_prediction
+    notebooks/4_recent_forecast
+    notebooks/weekly_predictions_RTE
diff --git a/notebooks/0_concat_all_tempo.ipynb → ..._guide/notebooks/0_concat_all_tempo.ipynb b/notebooks/0_concat_all_tempo.ipynb → ..._guide/notebooks/0_concat_all_tempo.ipynb
@@ -92,7 +92,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Conclusion\n",
+    "## Conclusion\n",
     "Ce notebook utilise l'API de Enedis pour récupérer l'historique des jours Tempo de 2014 à 2024.\n",
     "\n",
     "Un fichier temporaire est stocké dans le répertoir `/data/bronze` puis la version CSV est stockée dans le répertoire `/data/silver`.\n"

diff --git a/notebooks/0_transform_data_RTE.ipynb → ...uide/notebooks/0_transform_data_RTE.ipynb b/notebooks/0_transform_data_RTE.ipynb → ...uide/notebooks/0_transform_data_RTE.ipynb
@@ -23,7 +23,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Fetching data"
+    "## Fetching data"
    ]
   },
   {

diff --git a/...ooks/datascience/2_eolen_prediction.ipynb → ..._guide/notebooks/2_eolen_prediction.ipynb b/...ooks/datascience/2_eolen_prediction.ipynb → ..._guide/notebooks/2_eolen_prediction.ipynb
@@ -521,7 +521,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Modeling\n",
+    "## Modeling\n",
     "\n",
     "4 models are tested :\n",
     "- Only Total wind speed (no region details)\n",
@@ -778,7 +778,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Conclusion\n",
+    "## Conclusion\n",
     "\n",
     "In contrast with the photo-voltaic power prediction, the eolien is a bit more consistent with the expected trend :\n",
     "- using regional data features is better than global wind values (even with the time trend added to the global value)\n",

diff --git a/...ks/datascience/3_PV_prediction copy.ipynb → ...ser_guide/notebooks/3_PV_prediction.ipynb b/...ks/datascience/3_PV_prediction copy.ipynb → ...ser_guide/notebooks/3_PV_prediction.ipynb
@@ -496,7 +496,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Modeling\n",
+    "## Modeling\n",
     "\n",
     "4 models are tested :\n",
     "- Only Total sun flux (no region details)\n",
@@ -767,7 +767,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Conclusion\n",
+    "## Conclusion\n",
     "\n",
     "The model performances doesn't really follow the expected order (more feature => better performance)\n",
     "\n",

diff --git a/notebooks/weather/4_recent_forecast.ipynb → ...r_guide/notebooks/4_recent_forecast.ipynb b/notebooks/weather/4_recent_forecast.ipynb → ...r_guide/notebooks/4_recent_forecast.ipynb
@@ -176,7 +176,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Regions Selections\n",
+    "## Regions Selections\n",
     "\n",
     "This section shows how to select the regions of interest."
    ]
@@ -2010,7 +2010,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Prediction of the ENR production"
+    "## Prediction of the ENR production"
    ]
   },
   {
@@ -2161,7 +2161,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Conclusion\n",
+    "## Conclusion\n",
     "\n",
     "Nous avons vu comment récupérer les prévisions de la météo France pour le modèle ARPEGE 0.1°.\n",
     "\n",
@@ -2190,7 +2190,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.0"
+   "version": "3.1.-1"
   }
  },
  "nbformat": 4,

diff --git a/doc/user_guide/notebooks/index.ipynb b/doc/user_guide/notebooks/index.ipynb
diff --git a/.../datascience/weekly_predictions_RTE.ipynb → ...de/notebooks/weekly_predictions_RTE.ipynb b/.../datascience/weekly_predictions_RTE.ipynb → ...de/notebooks/weekly_predictions_RTE.ipynb
diff --git a/notebooks/weather/0_grib_to_xarray.ipynb b/notebooks/weather/0_grib_to_xarray.ipynb
@@ -11181,7 +11181,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.0"
+   "version": "3.1.undefined"
   }
  },
  "nbformat": 4,

diff --git a/notebooks/weather/1_concatenate_daily_forecasts.ipynb b/notebooks/weather/1_concatenate_daily_forecasts.ipynb
@@ -337,7 +337,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.0"
+   "version": "3.1.-1"
   }
  },
  "nbformat": 4,

diff --git a/output.png b/output.png
diff --git a/src/energy_forecast/__init__.py b/src/energy_forecast/__init__.py
@@ -1,3 +1,5 @@
 from pathlib import Path
+#: The root directory of the project
 ROOT_DIR = Path(__file__).parent.parent.parent
+#: The version of the package (unique reference to the package version)
 version = "0.1.0"
-Original file line number
+Diff line change
@@ Expand Up / @@ -20,6 +20,7 @@ Submodules @@
        energy_forecast.meteo
        energy_forecast.production_forecast
     Module contents
     ---------------
@@ Expand Down @@