.. PT3S documentation master file, created by
   sphinx-quickstart on Tue Feb 13 13:18:48 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to PT3S's documentation!
================================

.. image:: _static/Sir3S_Splash.jpg
   :alt: SIR 3S Splash
   :width: 100%
   :align: center
|

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

Contents:
---------

.. toctree::
   :maxdepth: 2

   started
   examples
   functions
   objects
   releases
   developers
* :ref:`genindex`

.. meta::
   :description: PT3S is a Python package developed by 3S Consult to serve as an interface between SIR 3S and Python. It enables the use of the SIR 3S model and calculated results in Python, facilitating pre- and post-processing steps for SIR 3S projects.
   :keywords: PT3S, Sir3S, SirGraf, SirCalc, 3S Consult, 3sconsult, 3s, python, anaconda, jupyter, notebooks, dx, mx, documentation, Dokumentation, python tools