Welcome to PT3S’s documentation!

Note

PT3S has been the main interface between SIR 3S and Python, but will now be replaced with the newer and in many aspects more powerful SIR 3S Python Toolkit. Many of the features that PT3S offers have been reimplemented and new features will continuously be added to the Toolkit while PT3S will no longer receive updates. PT3S is still compatible with SIR 3S 90.15 Quebec.

PT3S is only of interest to users with access to SIR 3S models.

Contents:

• Getting Started
  • Why Jupyter Notebooks, Python and PT3S are valuable when Working with SIR 3S
  • Install Anaconda
  • How to Start JupyterLab
  • Getting Started with PT3S
• Examples
  • Example 0: Installation
  • Example 1: Interactive Map and Network Color Diagram
  • Example 2: Time Curves
  • Example 3: Longitudinal Sections
  • Example 4: OSM PBF to SIR 3S SHP Import
  • Example 5: Loop over multiple SIR 3S calculations
  • Example 6: yFiles
  • Example 7: Source Spectrum and Fluid Age
  • Example 8: pandapipes
  • Example 9: Travel Time compared to Fluid Age
  • Example X: Example Template
• Functions
  • Read SIR 3S Model and Results
  • Read SIR 3S Results only
  • Methods
  • SdfCsv
  • Plot Network Color Diagram
  • Plot Source Spectrum
  • Plot Fluid Age
  • Plot Travel Time
• Classes and Objects
  • m Object
  • Dx object
  • Mx object
  • Known Issues
• Releases
  • SIR 3S Version 90.15
  • SIR 3S Version 90.14
• For Developers
  • Setting Up Git on Your Computer
  • Working with GitHub
  • Working with PyPI
  • Installing PT3S in Editable Mode
  • Generating the Documentation
  • Running Doctests
  • Testing the Deployment with Docker

• Index