DynamicalSystemFramework
The aim of this project is to rework the original Traffic Flow Dynamics Model. This rework consists of a full code rewriting, in order to implement more features (like intersections) and get advantage from the latest C++ updates.
Table of Contents
Installation
The library is available on PyPI:
pip install dsf-suite
To check the installation you can simply run
import dsf
print(dsf.__version__)
Installation (from source)
Requirements
The project requires C++20 or greater, cmake, tbb simdjson, spdlog, csv-parser and SQLiteCpp.
To install requirements on Ubuntu:
sudo apt install cmake libtbb-dev
To install requirements on macOS:
brew install cmake tbb
Installation (C++)
The library can be installed using CMake. To build and install the project in the default folder run:
cmake -B build -DCMAKE_BUILD_TYPE=Release && cmake --build build -j$(nproc)
sudo cmake --install build
Otherwise, it is possible to customize the installation path:
cmake -B build -DCMAKE_INSTALL_PREFIX=/path/to/install
then building and installing it (eventually in sudo mode) with:
cmake --build build
cmake --install build
Installation (Python)
If you want to use the library from Python, you can build the Python bindings using nanobind. Make sure you have tbb installed:
sudo apt install libtbb-dev
Then, the installation is automatic via uv:
uv build
or you can just use the classic pip:
pip install .
After installation, you should be able to import the module in Python:
import dsf
print(dsf.__version__)
If you encounter issues, ensure that the installation path is in your PYTHONPATH environment variable.
Examples
Examples in this repository are (slowly) being deprecated. You can build them by adding the cmake flag -DDSF_EXAMPLES=ON and you will find the exectuables under the examples folder. You can also find some Python examples.
New examples are being updated on dsf-examples.
GUI
If you need a visualization tool there is one available on dsf-gui. It is still in alpha stage but is already useful for some purposes.
For Developers
This project as a pre-commit configuration.
To use it properly, please install:
pip install pre-commit
pre-commit install
Testing
This project uses Doctest for testing.
If the project is compiled in Debug or Coverage mode, tests are always built.
Otherwise, you can add the -DDSF_TESTS=ON flag to enable test build.
cmake -B build -DDSF_TESTS=ON
cmake --build build -j$(nproc)
To run the tests use the command:
ctest --test-dir build -j$(nproc) --output-on-failure
Benchmarking
Some functionalities of the library have been benchmarked in order to assess their efficiency.
The benchmarks are performed using Google Benchmarks.
To build the benchmarks add the flag -DDSF_BENCHMARKS=ON :
cmake -B build -DDSF_BENCHMARKS=ON
cmake --build build -j$(nproc)
To run all the benchmarks together use the command:
cd benchmark
for f in ./*.out ; do ./$f ; done
Citing
If you use this software, please cite it using the metadata in CITATION.cff (GitHub's "Cite this repository" button exports it as BibTeX/APA), or via its DOI: 10.5281/zenodo.18745492.
Bibliography
- Mungai, Veronica (2024) Studio dell'ottimizzazione di una rete semaforica. University of Bologna, Bachelor's Degree in Physics [L-DM270]. Link to Thesis.
- Berselli, Gregorio (2024) Advanced queuing traffic model for accurate congestion forecasting and management. University of Bologna, Master's Degree in Physics [LM-DM270]. Link to Thesis.
- Berselli, Gregorio (2022) Modelli di traffico per la formazione della congestione su una rete stradale. University of Bologna, Bachelor's Degree in Physics [L-DM270]. Link to Thesis.
1 maintainer
Metadata
1 maintainer
Release files for dsf-suite 7.3.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| dsf_suite-7.3.2.tar.gz | 188.5 kB | Details |
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| dsf_suite-7.3.2-cp314-cp314-win_amd64.whl | CPython 3.14 | CPython 3.14 | Windows x86-64 | Details |
| dsf_suite-7.3.2-cp314-cp314-manylinux_2_28_x86_64.whl | CPython 3.14 | CPython 3.14 | Linux glibc 2.28+ x86-64 | Details |
| dsf_suite-7.3.2-cp314-cp314-macosx_26_0_arm64.whl | CPython 3.14 | CPython 3.14 | macOS 26.0+ ARM64 | Details |
| dsf_suite-7.3.2-cp313-cp313-win_amd64.whl | CPython 3.13 | CPython 3.13 | Windows x86-64 | Details |
| dsf_suite-7.3.2-cp313-cp313-manylinux_2_28_x86_64.whl | CPython 3.13 | CPython 3.13 | Linux glibc 2.28+ x86-64 | Details |
| dsf_suite-7.3.2-cp313-cp313-macosx_26_0_arm64.whl | CPython 3.13 | CPython 3.13 | macOS 26.0+ ARM64 | Details |
| dsf_suite-7.3.2-cp312-cp312-win_amd64.whl | CPython 3.12 | CPython 3.12 | Windows x86-64 | Details |
| dsf_suite-7.3.2-cp312-cp312-manylinux_2_28_x86_64.whl | CPython 3.12 | CPython 3.12 | Linux glibc 2.28+ x86-64 | Details |
| dsf_suite-7.3.2-cp312-cp312-macosx_26_0_arm64.whl | CPython 3.12 | CPython 3.12 | macOS 26.0+ ARM64 | Details |
Total release size: 17.0 MB
Release files / dsf_suite-7.3.2.tar.gz
| Download URL | dsf_suite-7.3.2.tar.gz |
|---|---|
| Size | 188.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
505c69f768ffd1d60bd8a9178631c67a3aa3981a715bd486788b3614fe855622
|
|
BLAKE2b-256 checksum How to use checksums |
6dc5d69aa315fda5e8a0f97174cb665c6ee302f77aabc098bc519dd3bcef7a65
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
Release files / dsf_suite-7.3.2-cp314-cp314-win_amd64.whl
| Download URL | dsf_suite-7.3.2-cp314-cp314-win_amd64.whl |
|---|---|
| Size | 1.7 MB |
| Tags | CPython 3.14 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
5b1181b2db22e12c6d7e1788734bca5ecdb592af5536fee84c665cfe72d18355
|
|
BLAKE2b-256 checksum How to use checksums |
556ef7fbf7933cd396af30524ead4c3812f3e189912e31fda86a5798a7808558
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
Release files / dsf_suite-7.3.2-cp314-cp314-manylinux_2_28_x86_64.whl
| Download URL | dsf_suite-7.3.2-cp314-cp314-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 2.3 MB |
| Tags | CPython 3.14 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
872cd0b7ed7c2fcadbf2580ba3502a2103ecf85ba57920ef13c54df413d980e0
|
|
BLAKE2b-256 checksum How to use checksums |
f99ae086d40dec5318166e50664420161146234ebc3f37f016ee802f13725772
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
Release files / dsf_suite-7.3.2-cp314-cp314-macosx_26_0_arm64.whl
| Download URL | dsf_suite-7.3.2-cp314-cp314-macosx_26_0_arm64.whl |
|---|---|
| Size | 1.6 MB |
| Tags | CPython 3.14 macOS 26.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
40d95ca9cb125ced2e8455fd8afffda309ff90d99c06c3349c664135f97f31b6
|
|
BLAKE2b-256 checksum How to use checksums |
2b57f1b9bb2ed30629735fca432808daeff71615dabf4f1e00b6050bad638fa1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
Release files / dsf_suite-7.3.2-cp313-cp313-win_amd64.whl
| Download URL | dsf_suite-7.3.2-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 1.7 MB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
7cf167a7bf4c2fd0fceabe0cec2a4592ed0799ffee74d73766885a8866dc1c2c
|
|
BLAKE2b-256 checksum How to use checksums |
cfe24ba7a4a9ed8750101b8409af5155ee0b3588f7e680d4ea051eb71eb8f0df
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
Release files / dsf_suite-7.3.2-cp313-cp313-manylinux_2_28_x86_64.whl
| Download URL | dsf_suite-7.3.2-cp313-cp313-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 2.3 MB |
| Tags | CPython 3.13 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
6db876cab023bda59cd78c637e2e80334c7348dcf46f94d6537d1d6672a821b1
|
|
BLAKE2b-256 checksum How to use checksums |
11a97e438603706883292f0c7480fe8a9a7976e69f0d0f845a0ece0891227d0e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
Release files / dsf_suite-7.3.2-cp313-cp313-macosx_26_0_arm64.whl
| Download URL | dsf_suite-7.3.2-cp313-cp313-macosx_26_0_arm64.whl |
|---|---|
| Size | 1.6 MB |
| Tags | CPython 3.13 macOS 26.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
ade56772346044e43719839bcd2fdbe6539181e4c44d018761557085b8f52e20
|
|
BLAKE2b-256 checksum How to use checksums |
580d4b7888b22daa96b08e5b3aba4bfe4a0341a251ce04fae3469865ff377845
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
Release files / dsf_suite-7.3.2-cp312-cp312-win_amd64.whl
| Download URL | dsf_suite-7.3.2-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 1.7 MB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
4c8f663724d1514293c4c77aeb59aeef1f0cd35c5a135dd8352ee58e92fd4ab4
|
|
BLAKE2b-256 checksum How to use checksums |
160ea05cafd4a3254f30cf6b2d401ffcdad568bedba07bb9ac56c0a30004ea79
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
Release files / dsf_suite-7.3.2-cp312-cp312-manylinux_2_28_x86_64.whl
| Download URL | dsf_suite-7.3.2-cp312-cp312-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 2.3 MB |
| Tags | CPython 3.12 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
4945540c595201327a21708031e3a20b964b128070581541eaba1dc1a54894f4
|
|
BLAKE2b-256 checksum How to use checksums |
811512c7274b14c56bc3f07fdfd6ef3f76d8454b2aec7ca1ef12015e94f8ae05
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
Release files / dsf_suite-7.3.2-cp312-cp312-macosx_26_0_arm64.whl
| Download URL | dsf_suite-7.3.2-cp312-cp312-macosx_26_0_arm64.whl |
|---|---|
| Size | 1.6 MB |
| Tags | CPython 3.12 macOS 26.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
512b227670514bd0832354446b566045ce5b69bae8be6850513787160ef674f6
|
|
BLAKE2b-256 checksum How to use checksums |
e0708708de3d7f1d9d2b1f7fe0ec676d2b12e7d13c553205751db9137e61e8ca
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
