sir3stoolkit 90.15.13

SIR3S Toolkit

---

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. Feel free to attach images or other relevant materials to help us better understand your request.

For other requests, please contact us at [e-mail].

License

MIT License. See LICENSE for details.