Examples
========

Welcome to the Examples Page! Here, you will find a variety of examples that demonstrate the capabilities and usage of PT3S. Each example is available for both **viewing** and **downloading** as an `.ipynb` file. 

In the Example-Notebooks the corresponding SIR 3S Example-Models are (re-)calculated using your local SirCalc.
Additonal necessary python packages are installed on your device using pip.

.. _ex0:

Example 0: Installation 
-----------------------

This example does not demonstrate use cases of PT3S, but gives an overview over important commands to install, administer and import PT3S.

You can view the Notebook `here <Example0.html>`_.

   
You can download the Notebook file :download:`here <Example0.ipynb>`.

.. _ex1:

Example 1: Interactive Map and Network Color Diagram
----------------------------------------------------

This example demonstrates how GeoDataFrames (gdfs) created by PT3S can be used with geopandas' explore for interactive maps with folium/leaflet.js and with geopandas' plot with matplotlib.

You can view the Notebook `here <Example1.html>`_.

You can download the Notebook file :download:`here <Example1.ipynb>`.

.. _ex2:

Example 2: Time Curves
----------------------

This example demonstrates how raw time curve data read by PT3S can be used to create both interactive and non-interactive plots with Matplotlib and Bokeh, and to generate a printable output.

You can view the Notebook `here <Example2.html>`_.

   
You can download the Notebook file :download:`here <Example2.ipynb>`.

.. _ex3:

Example 3: Longitudinal Sections
--------------------------------

This example demonstrates how longitudinal sections data read by PT3S can be accessed and used to create non-interactive plots with Matplotlib and interactive plots with Bokeh.

You can view the Notebook `here <Example3.html>`_.


You can download the Notebook file :download:`here <Example3.ipynb>`.

.. _ex4:

Example 4: OSM PBF to SIR 3S SHP Import
---------------------------------------

This example demonstrates how to convert OSM data into shape files for import into SIR 3S.

You can view the Notebook `here <Example4.html>`_.


You can download the Notebook file :download:`here <Example4.ipynb>`.

.. _ex5:

Example 5: Loop over multiple SIR 3S calculations
-------------------------------------------------

This example demonstrates how to modify the SirCalcXmlFile, perform calculations on its state, and plot the results. These steps are executed in a loop over several different SIR 3S calculations.

You can view the Notebook `here <Example5.html>`_.


You can download the Notebook file :download:`here <Example5.ipynb>`.

.. _ex6:

Example 6: yFiles
-------------------------------------------------

This example demonstrates how the NetworkX-Graph created by PT3S can be used with yFiles.

You can view the Notebook `here <Example6.html>`_.


You can download the Notebook file :download:`here <Example6.ipynb>`.

.. _ex7:

Example 7: Source Spectrum
--------------------------

This example demonstrates how GeoDataFrames (gdfs) and V3_dataframe created by PT3S can be used with matplotlib to create an interactive depiction of a source spectrum.

You can view the Notebook `here <Example7.html>`_.


You can download the Notebook file :download:`here <Example7.ipynb>`.

.. _ex8:

Example 8: pandapipes
---------------------

This Example demonstrates a pandapipes calculation of a 1-pipe, 2-nodes SIR 3S model.

You can view the Notebook `here <Example8.html>`_.


You can download the Notebook file :download:`here <Example8.ipynb>`.

.. _exX:

Example X: Example Template
---------------------------

This example does not demonstrate use cases of PT3S, but serves as a template for contributors, who want to create their own Example.

You can view the Notebook `here <ExampleX.html>`_.


You can download the Notebook file :download:`here <ExampleX.ipynb>`.