# DynamicalSystemFramework
[](https://github.com/physycom/DynamicalSystemFramework/releases/latest)
[](https://pypi.org/project/dsf-mobility/)
[](https://en.wikipedia.org/wiki/C%2B%2B#Standardization)
[](https://github.com/oneapi-src/oneTBB)
[](https://github.com/gabime/spdlog)
[](https://github.com/vincentlaucsb/csv-parser)
[](https://github.com/simdjson/simdjson)
[](https://codecov.io/gh/physycom/DynamicalSystemFramework)
The aim of this project is to rework the original [Traffic Flow Dynamics Model](https://github.com/Grufoony/TrafficFlowDynamicsModel).
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](#installation)
- [Installation (from source)](#installation-from-source)
- [Testing](#testing)
- [Benchmarking](#benchmarking)
- [Citing](#citing)
- [Bibliography](#bibliography)
## Installation
The library is available on `PyPI`:
```shell
pip install dsf-mobility
```
To check the installation you can simply run
```python
import dsf
print(dsf.__version__)
```
## Installation (from source)
### Requirements
The project requires `C++20` or greater, `cmake`, `tbb` `simdjson`, and `spdlog` (with `fmt`).
To install requirements on Ubuntu:
```shell
sudo apt install libtbb-dev libspdlog-dev libsimdjson-dev cmake
```
To install requirements on macOS:
```shell
brew install tbb simdjson spdlog cmake
```
Utilities are written in python. To install their dependencies:
```shell
pip install -r ./requirements.txt
```
### Installation (C++)
The library can be installed using CMake. To build and install the project in the default folder run:
```shell
cmake -B build -DCMAKE_BUILD_TYPE=Release && cmake --build build
sudo cmake --install build
```
Otherwise, it is possible to customize the installation path:
```shell
cmake -B build -DCMAKE_INSTALL_PREFIX=/path/to/install
```
then building and installing it (eventually in sudo mode) with:
```shell
cmake --build build
cmake --install build
```
## Installation (Python)
If you want to use the library from Python, you can build the Python bindings using [pybind11](https://github.com/pybind/pybind11). Make sure you have doxygen installed to generate the docstrings:
```shell
sudo apt install doxygen
```
Then, the installation is automatic via `pip`:
```shell
pip install .
```
After installation, you should be able to import the module in Python:
```python
import dsf
print(dsf.__version__)
```
If you encounter issues, ensure that the installation path is in your `PYTHONPATH` environment variable.
## Testing
This project uses [Doctest](https://github.com/doctest/doctest) for testing.
To compile tests run:
```shell
cd test
cmake -B build && make -C build
```
To run all the tests together use the command:
```shell
./dsf_tests.out
```
## Benchmarking
Some functionalities of the library have been benchmarked in order to assess their efficiency.
The benchmarks are performed using a small toolkit developed by @sbaldu, in order to keep them simple and
without needing to rely on large external libraries.
To compile the benchmarks use the commands:
```shell
cd benchmark
cmake -B build && make -C build
```
To run all the benchmarks together use the command:
```shell
for f in ./*.out ; do ./$f ; done
```
## Citing
```BibTex
@misc{DSF,
author = {Berselli, Gregorio and Balducci, Simone},
title = {Framework for modelling dynamical complex systems.},
year = {2023},
url = {https://github.com/physycom/DynamicalSystemFramework},
publisher = {GitHub},
howpublished = {\url{https://github.com/physycom/DynamicalSystemFramework}}
}
```
## Bibliography
- **Mungai, Veronica** (2024) *Studio dell'ottimizzazione di una rete semaforica*. University of Bologna, Bachelor's Degree in Physics [L-DM270]. [Link to Thesis](https://amslaurea.unibo.it/id/eprint/32525/).
- **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](https://amslaurea.unibo.it/id/eprint/32191/).
- **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](https://amslaurea.unibo.it/id/eprint/26332/).
Raw data
{
"_id": null,
"home_page": "https://github.com/physycom/DynamicalSystemFramework",
"name": "dsf-mobility",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "traffic, simulation, dynamics, network, modeling, transportation, mobility, congestion, flow, optimization",
"author": "Grufoony",
"author_email": "gregorio.berselli@studio.unibo.it",
"download_url": "https://files.pythonhosted.org/packages/19/09/3f02230ebd14250d86f11c35e24131a2440753cd20c435241a928937e0ee/dsf_mobility-3.11.0.tar.gz",
"platform": null,
"description": "# DynamicalSystemFramework\n[](https://github.com/physycom/DynamicalSystemFramework/releases/latest)\n[](https://pypi.org/project/dsf-mobility/)\n[](https://en.wikipedia.org/wiki/C%2B%2B#Standardization)\n[](https://github.com/oneapi-src/oneTBB)\n[](https://github.com/gabime/spdlog)\n[](https://github.com/vincentlaucsb/csv-parser)\n[](https://github.com/simdjson/simdjson)\n[](https://codecov.io/gh/physycom/DynamicalSystemFramework)\n\nThe aim of this project is to rework the original [Traffic Flow Dynamics Model](https://github.com/Grufoony/TrafficFlowDynamicsModel).\nThis rework consists of a full code rewriting, in order to implement more features (like *intersections*) and get advantage from the latest C++ updates.\n\n## Table of Contents\n- [Installation](#installation)\n- [Installation (from source)](#installation-from-source)\n- [Testing](#testing)\n- [Benchmarking](#benchmarking)\n- [Citing](#citing)\n- [Bibliography](#bibliography)\n\n## Installation\nThe library is available on `PyPI`:\n```shell\npip install dsf-mobility\n```\n\nTo check the installation you can simply run\n```python\nimport dsf\n\nprint(dsf.__version__)\n```\n\n## Installation (from source)\n\n### Requirements\nThe project requires `C++20` or greater, `cmake`, `tbb` `simdjson`, and `spdlog` (with `fmt`).\nTo install requirements on Ubuntu:\n```shell\nsudo apt install libtbb-dev libspdlog-dev libsimdjson-dev cmake\n```\nTo install requirements on macOS:\n```shell\nbrew install tbb simdjson spdlog cmake\n```\n\nUtilities are written in python. To install their dependencies:\n```shell\npip install -r ./requirements.txt\n```\n### Installation (C++)\nThe library can be installed using CMake. To build and install the project in the default folder run:\n```shell\ncmake -B build -DCMAKE_BUILD_TYPE=Release && cmake --build build\nsudo cmake --install build\n```\nOtherwise, it is possible to customize the installation path:\n```shell\ncmake -B build -DCMAKE_INSTALL_PREFIX=/path/to/install\n```\nthen building and installing it (eventually in sudo mode) with:\n```shell\ncmake --build build\ncmake --install build\n```\n\n## Installation (Python)\nIf you want to use the library from Python, you can build the Python bindings using [pybind11](https://github.com/pybind/pybind11). Make sure you have doxygen installed to generate the docstrings:\n```shell\nsudo apt install doxygen\n```\n\nThen, the installation is automatic via `pip`:\n```shell\npip install .\n```\n\nAfter installation, you should be able to import the module in Python:\n```python\nimport dsf\n\nprint(dsf.__version__)\n```\n\nIf you encounter issues, ensure that the installation path is in your `PYTHONPATH` environment variable.\n\n## Testing\nThis project uses [Doctest](https://github.com/doctest/doctest) for testing.\n\nTo compile tests run:\n```shell\ncd test\ncmake -B build && make -C build\n```\nTo run all the tests together use the command:\n```shell\n./dsf_tests.out\n```\n\n## Benchmarking\nSome functionalities of the library have been benchmarked in order to assess their efficiency. \nThe benchmarks are performed using a small toolkit developed by @sbaldu, in order to keep them simple and\nwithout needing to rely on large external libraries. \nTo compile the benchmarks use the commands:\n```shell\ncd benchmark\ncmake -B build && make -C build\n```\nTo run all the benchmarks together use the command:\n```shell\nfor f in ./*.out ; do ./$f ; done\n```\n\n## Citing\n\n```BibTex\n@misc{DSF,\n author = {Berselli, Gregorio and Balducci, Simone},\n title = {Framework for modelling dynamical complex systems.},\n year = {2023},\n url = {https://github.com/physycom/DynamicalSystemFramework},\n publisher = {GitHub},\n howpublished = {\\url{https://github.com/physycom/DynamicalSystemFramework}}\n}\n```\n\n## Bibliography\n- **Mungai, Veronica** (2024) *Studio dell'ottimizzazione di una rete semaforica*. University of Bologna, Bachelor's Degree in Physics [L-DM270]. [Link to Thesis](https://amslaurea.unibo.it/id/eprint/32525/).\n- **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](https://amslaurea.unibo.it/id/eprint/32191/).\n- **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](https://amslaurea.unibo.it/id/eprint/26332/).\n",
"bugtrack_url": null,
"license": "CC-BY-NC-SA-4.0",
"summary": "DSF C++ core with Python bindings via pybind11",
"version": "3.11.0",
"project_urls": {
"Documentation": "https://physycom.github.io/DynamicalSystemFramework/",
"Homepage": "https://github.com/physycom/DynamicalSystemFramework",
"Issues": "https://github.com/physycom/DynamicalSystemFramework/issues",
"Repository": "https://github.com/physycom/DynamicalSystemFramework"
},
"split_keywords": [
"traffic",
" simulation",
" dynamics",
" network",
" modeling",
" transportation",
" mobility",
" congestion",
" flow",
" optimization"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1f54078afff425fa75081ae86f5a5751a2ad124624496cbe7e3040ed587e69b8",
"md5": "8aa5d2496e87938a3699d4216a3095a2",
"sha256": "ac0175edd232b482871b6ee6825d205d37c60e08f6a2f512eb01c46c090db887"
},
"downloads": -1,
"filename": "dsf_mobility-3.11.0-cp310-cp310-macosx_15_0_arm64.whl",
"has_sig": false,
"md5_digest": "8aa5d2496e87938a3699d4216a3095a2",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.10",
"size": 828695,
"upload_time": "2025-10-06T11:30:05",
"upload_time_iso_8601": "2025-10-06T11:30:05.347758Z",
"url": "https://files.pythonhosted.org/packages/1f/54/078afff425fa75081ae86f5a5751a2ad124624496cbe7e3040ed587e69b8/dsf_mobility-3.11.0-cp310-cp310-macosx_15_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "36dd2f03472263621e03a9acd0b91e4dffe5a95765220782af364e66cf178f33",
"md5": "5512628501db5281d439d2bcc4f807a5",
"sha256": "13afd581c3f945c8ca69be2cbf14ab09705ddb72db7848b5711f1afe861bb746"
},
"downloads": -1,
"filename": "dsf_mobility-3.11.0-cp310-cp310-manylinux_2_39_x86_64.whl",
"has_sig": false,
"md5_digest": "5512628501db5281d439d2bcc4f807a5",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.10",
"size": 1135708,
"upload_time": "2025-10-06T11:30:07",
"upload_time_iso_8601": "2025-10-06T11:30:07.671238Z",
"url": "https://files.pythonhosted.org/packages/36/dd/2f03472263621e03a9acd0b91e4dffe5a95765220782af364e66cf178f33/dsf_mobility-3.11.0-cp310-cp310-manylinux_2_39_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a43386dcdedf066ba525c9da8442e2268fe033e2d1d8b49fead8dcb028ededd0",
"md5": "46eec37fa8757d94a8abc355bea90cb7",
"sha256": "e58b8306f5aa16431a58b09c8983ccb0d778213d2c1d4c5404d677bdad2d9206"
},
"downloads": -1,
"filename": "dsf_mobility-3.11.0-cp312-cp312-macosx_15_0_arm64.whl",
"has_sig": false,
"md5_digest": "46eec37fa8757d94a8abc355bea90cb7",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": ">=3.10",
"size": 832143,
"upload_time": "2025-10-06T11:30:08",
"upload_time_iso_8601": "2025-10-06T11:30:08.713017Z",
"url": "https://files.pythonhosted.org/packages/a4/33/86dcdedf066ba525c9da8442e2268fe033e2d1d8b49fead8dcb028ededd0/dsf_mobility-3.11.0-cp312-cp312-macosx_15_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7fb2072f104707d5071ccf0ebf221da8d7d565218196afd56d71a420d0bf4707",
"md5": "ff331a0bde1f81d6a14b27ecc6181b08",
"sha256": "4cded86e1ad32626ec3ce308503d8b45dca37f83257194cd5bdf8d130db188d6"
},
"downloads": -1,
"filename": "dsf_mobility-3.11.0-cp312-cp312-manylinux_2_39_x86_64.whl",
"has_sig": false,
"md5_digest": "ff331a0bde1f81d6a14b27ecc6181b08",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": ">=3.10",
"size": 1136363,
"upload_time": "2025-10-06T11:30:09",
"upload_time_iso_8601": "2025-10-06T11:30:09.905194Z",
"url": "https://files.pythonhosted.org/packages/7f/b2/072f104707d5071ccf0ebf221da8d7d565218196afd56d71a420d0bf4707/dsf_mobility-3.11.0-cp312-cp312-manylinux_2_39_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "19093f02230ebd14250d86f11c35e24131a2440753cd20c435241a928937e0ee",
"md5": "2b2e298c27f8f9dfcb0abbe21c6c86f5",
"sha256": "c7573b246de76f05dbcfc28ba28f815325301798cf7bd95797ae5038d3afcbab"
},
"downloads": -1,
"filename": "dsf_mobility-3.11.0.tar.gz",
"has_sig": false,
"md5_digest": "2b2e298c27f8f9dfcb0abbe21c6c86f5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 115091,
"upload_time": "2025-10-06T11:30:10",
"upload_time_iso_8601": "2025-10-06T11:30:10.946042Z",
"url": "https://files.pythonhosted.org/packages/19/09/3f02230ebd14250d86f11c35e24131a2440753cd20c435241a928937e0ee/dsf_mobility-3.11.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-06 11:30:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "physycom",
"github_project": "DynamicalSystemFramework",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "contextily",
"specs": []
},
{
"name": "geopandas",
"specs": []
},
{
"name": "matplotlib",
"specs": []
},
{
"name": "networkx",
"specs": []
},
{
"name": "numpy",
"specs": []
},
{
"name": "osmnx",
"specs": []
},
{
"name": "pandas",
"specs": []
},
{
"name": "Pillow",
"specs": []
},
{
"name": "seaborn",
"specs": []
},
{
"name": "tqdm",
"specs": []
},
{
"name": "opencv-python",
"specs": []
},
{
"name": "shapely",
"specs": []
}
],
"lcname": "dsf-mobility"
}
JSON
