.. _example_notebooks_index:

=================
Example Notebooks
=================

Interactive Jupyter notebooks demonstrating complete workflows. Download and run these
to see TEEHR in action.

.. grid:: 1 2 3 3
    :gutter: 3

    .. grid-item-card:: Loading Local Data
        :link: notebooks/01_loading_local_data
        :link-type: doc
        :class-card: notebook-card
        :shadow: md

        Load geospatial and timeseries data from local files into a TEEHR evaluation
        dataset.

        +++

        :download:`Download notebook <notebooks/01_loading_local_data.ipynb>`

    .. grid-item-card:: Adding Calculated Fields
        :link: notebooks/02_adding_calculated_fields
        :link-type: doc
        :class-card: notebook-card
        :shadow: md

        Extend your evaluation dataset with user-defined calculated fields for enhanced grouping and filtering.

        +++

        :download:`Download notebook <notebooks/02_adding_calculated_fields.ipynb>`

    .. grid-item-card:: Ensemble Forecast Evaluation
        :link: notebooks/03_ensemble_metrics
        :link-type: doc
        :class-card: notebook-card
        :shadow: md

        Evaluate probabilistic ensemble forecast performance with built-in metrics.

        +++

        :download:`Download notebook <notebooks/03_ensemble_metrics.ipynb>`

    .. grid-item-card:: Fetching NWM Streamflow
        :link: notebooks/04_fetching_nwm_streamflow
        :link-type: doc
        :class-card: notebook-card
        :shadow: md

        Retrieve USGS observations and National Water Model streamflow forecasts.

        +++

        :download:`Download notebook <notebooks/04_fetching_nwm_streamflow.ipynb>`

    .. grid-item-card:: Fetching NWM Gridded Data
        :link: notebooks/05_fetching_nwm_gridded_data
        :link-type: doc
        :class-card: notebook-card
        :shadow: md

        Access NWM gridded output and summary to polygons.

        +++

        :download:`Download notebook <notebooks/05_fetching_nwm_gridded_data.ipynb>`


.. toctree::
   :maxdepth: 2
   :caption: Example Notebooks
   :hidden:

   Loading Local Data <notebooks/01_loading_local_data>
   Adding Calculated Fields <notebooks/02_adding_calculated_fields>
   Ensemble Forecast Evaluation <notebooks/03_ensemble_metrics>
   Fetching USGS and NWM Streamflow Data <notebooks/04_fetching_nwm_streamflow>
   Fetching NWM Gridded Data <notebooks/05_fetching_nwm_gridded_data>