:orphan:

| ☷ :doc:`return to Workflows <../../../4_workflows/workflows>`
| ☷ :doc:`go to Preprocess CWatM inputs [FR] <user_guide_cwatm_inputs_France>`

Monitoring tools
===============================

Model parametrization is usually a tricky part. In order to facilitate the monitoring of CWatM model parametrization, 
we provide a graphical visualization tool named **plot_timeseries.py**. As this tool is only remotely connected to
GEOP4TH, it is not intended to be imported as other modules. Instead, you can find it in the **geop4th/src/misc/cwatm** folder.

This tool generates a figure based on parameters passed in an associated *settings.yaml* file (Note: the path to this .yaml file
has to be specified in *plot_timeseries.py*). An example of such a *settings.yaml* file is provided in the same folder as *plot_timeseries.py*.

.. note:: 

    **Automatic definition of locations**

    If the parameter ``coords_data: 'auto'`` is specified, it is required to pass a ``gauge_vector`` filepath
    pointing to a vector file containing all desired gauge points as well as quantity timeseries for each point.
    For instance, for discharge data in France, such a file can be automatically generated by using the following function in the |IDE|:
	
    .. code-block:: python3

        import geop4th as geo
	
        geo.download_eaufrance(
            dst_folder = <r"Path/to/output/folder">, 
            masks = <mask variable or r"Path/to/mask/file">,
            filetypes = 'geojson',
            start_year = <2000>,
            end_year = <2025>
            )
	
        ds = geo.standardize_eaufrance(
            <r"Path/to/previously/downloaded/files">
            )
		
        geo.export(ds, <r"Filepath/to/result/file.json">)
		
        # This resulting file can be used as the ``gauge_vector``.


Study Case: Pays Basque
^^^^^^^^^^^^^^^^^^^^^^^^

Discharge gauge stations
""""""""""""""""""""""""""""""

.. figure:: Gauge_station_locations.png
    :align: center

    Locations of gauge stations
	
    Data are from HydroPortail (`API Hub'Eau <https://hubeau.eaufrance.fr/page/api-hydrometrie>`_).


Discharge monitoring
"""""""""""""""""""""""

..
   (comment)
   .. raw:: html
     
	   <iframe src="discharge_daily_log_01h35_fr.html" width="750px" height="680px"></iframe>
	
	   <a href="_static/discharge_daily_log_01h35_fr.html" target="_blank">📊 View the full HTML file</a>


.. raw:: html

    <a href="../../_images/discharge_daily_log_22h25_en.html" target="_blank">
        <img src="../../_images/discharge_daily_log_14h42_en.png" alt="📊 View the full HTML figure" width="100%">
    </a>






.. |ERA5| raw:: html
  
  <abbr title="Fifth generation ECMWF reanalysis for the global climate and weather for the past 8 decades">ERA5</abbr>
  
.. |DEM| raw:: html

  <abbr title="Digital Elevation Model">DEM</abbr>

.. |IDE| raw:: html

  <abbr title="Integrated development environment (Spyder, PyCharm, Visual Studio Code...)">IDE</abbr>

.. # define a hard line break for HTML
.. |br| raw:: html

   <br>

.. |nbsp| unicode:: 0xA0 
   :trim: