sir3stoolkit

SIR 3S Toolkit

SIR 3S Toolkit is a Python package developed by 3S Consult that provides a programming interface for SIR 3S - a software for the simulation, analysis and optimization of flow processes in gas/water/heat supply networks, plants, pipelines and caverns.

At its core, the package wraps basic functionality of SIR 3S, offering a low-level access to the creation, modification and simulation of SIR 3S models.

On top of this core, higher-level functionality is provided, enabling more powerful and intuitive interactions with SIR 3S models.

This layered architecture of the SIR 3S Toolkit ensures both flexibility and extensibility for advanced applications.

Note: This package is a client toolkit for the proprietary SIR 3S software. A valid license for SIR 3S is required to use this package in production.

Features

Create new SIR 3S models
Modify existing SIR 3S models
Simulate SIR 3S models
Read data and simulation results from SIR 3S models

Documentation

For detailed documentation, visit SIR 3S Toolkit Documentation.

PyPI

You can find the SIR 3S Toolkit package on PyPI.

Installation

To install the SIR 3S Toolkit, use pip:

pip install sir3stoolkit

Quick Start

from sir3stoolkit.core import wrapper

SIR3S_SIRGRAF_DIR = r"C:\SIR3S\SirGraf-90-15-00-12_Quebec_x64"
wrapper.Initialize_Toolkit(SIR3S_SIRGRAF_DIR)

model = wrapper.SIR3S_Model()
model.OpenModel(dbName=r"example_model.db3",
                providerType=model.ProviderTypes.SQLite,
                Mid="M-1-0-1",
                saveCurrentlyOpenModel=False,
                namedInstance="",
                userID="",
                password="")

model.ExecCalculation(True)

Contact

If you’d like to report a bug or suggest an improvement for the SIR 3S Toolkit, please open a new issue on GitHub. Describe the situation in detail — whether it’s a bug you encountered or a feature you’d like to see improved. Provide the SIR Graf, SIR Calc and SIR 3S Toolkit versions you used. Feel free to attach images or other relevant materials to help us better understand your request.

For other requests, please contact us at sir3stoolkit@3sconsult.de.

License

MIT License. See LICENSE for details.

Metadata

Release files for sir3stoolkit 90.15.25

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sir3stoolkit 90.15.25
File	Size	Uploaded
sir3stoolkit-90.15.25.tar.gz	442.5 kB	Aug 3, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for sir3stoolkit 90.15.25
File	Interpreter	ABI	Platform	Reset
sir3stoolkit-90.15.25-py3-none-any.whl 443.4 kB Aug 3, 2026	Python 3	none	any	Details

Total release size: 885.8 kB

Release files / sir3stoolkit-90.15.25.tar.gz

Download URL	sir3stoolkit-90.15.25.tar.gz
Size	442.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`5c2d804d1c2241c57f61af889c19641190752374c352cbd9340bb1f97e565698`
BLAKE2b-256 checksum How to use checksums	`66f6eb7250245418c791f54e3a7c2903b932447043dd563d64ec2086e7fb6549`
Upload date	Aug 3, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.10`

Release files / sir3stoolkit-90.15.25-py3-none-any.whl

Download URL	sir3stoolkit-90.15.25-py3-none-any.whl
Size	443.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`834ccc8f612a78f0597283003c3b222d23e53bbd4b66bf708d943922d857579d`
BLAKE2b-256 checksum How to use checksums	`ed4df7610d192af20f73b66d724ba4854e5c3331c32d17f1be27a5ebb113929a`
Upload date	Aug 3, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.10`