SiTT (Simulation of Traffic and Transport)

SiTT is a program suite to simulate the traffic and transport of pre-industrial societies. It uses an agent-based approach to model the simulation. An agent can be thought of as a batch of cargo transported through the network (rather than an individual person travelling it).

Note: This suite was developed as part of the STRADA project at the University of Trier.

Main repository: https://codeberg.org/SiTT/SiTT
Public mirror: https://github.com/Simulation-of-Traffic-and-Transport/SiTT

Table of Contents

• Installation
• Documentation
• Examples
• License

Installation

You need Python 3.11 or later to run SiTT Moreover, the principal components of the simulation are contained in a PostgreSQL database, more specifically one with the PostGIS extension. PostGis should be pretty recent and should have Geos >= 3.11.0 included, otherwise we will have to implement certain things in Python which will be pretty slow. SiTT also makes use of JSONB in PostgreSQL, but since this has been introduced in version 9.4, it is likely, your database server will support this feature anyway.

pip install sitt

After installation, you can run SiTT using it as a module:

python -m sitt

This will activate the command line interface and print a help message. For other ways to run SiTT, check out the examples below.

Dependencies

Installing SiTT as package should install all dependent packages, too. You might want to install them by hand and/or install the extra dependencies for certain use cases:

pip install -r requirements.txt
pip install -r requirements_extras.txt

The extras file contains optional python modules such as pytest or the binary Postgres package.

Testing

You can run unit tests using pytest:

pip install pytest
cd tests
pytest -v .

Documentation

You can read some documentation on the following pages:

• SiTT'S General Concept (with figures)
• Database Reference

Examples

Can be found in the examples directory.

License

sitt is distributed under the terms of the MIT license.