opentnsim 1.3.7

The OpenTNSim package aims to facilitate the analysis of network performance for different network configurations, fleet compositions and traffic rules.

OpenTNSim

Open source Transport Network Simulation - Analysis of traffic behaviour on networks for different traffic scenarios and network configurations.

Documentation can be found: here

Book

You can find the opentnsim book, based on the examples in the notebooks folder on the opentnsim-book website.

Installation

To install OpenTNSim, run this command in your terminal:

pip install opentnsim

To also install the extra dependencies used for testing you can use:

pip install opentnsim[testing]

To install in development mode, you can use (from the source directory)

pip install -e .

This is the preferred method to install OpenTNSim, as it will always install the most recent stable release.

If you don not have pip installed, this Python installation guide can guide you through the process.

You can read the documentation for other installation methods.

Testing

You can run the unit tests

pytest

Or you can run the notebook tests:

pytest --nbmake ./notebooks --nbmake-kernel=python3 --ignore ./notebooks/cleanup ./notebooks/students

Or you can run a specific test like this:

pytest -k test_single_engine

`

Examples

The benefit of OpenTNSim is the generic set-up. A number of examples are presented in a seperate Jupyter Notebook repository. Information on how to use the notebooks is presented in that repository as well.

Book

Based on the examples and docs a book can be generated using the commands make book and cleaned up using make clean-book. These commands are unix only.

Code quality

Code quality is checked using sonarcloud. You can see results on the sonarcloud website. For now we have disabled coverage and duplication checks. These can be enabled when we include coverage measurements and reduce duplication by optimizing the tests.

OpenCLSim

OpenTNSim makes use of the OpenCLSim code. Both packages are maintained by the same team of developers. There are some differences between packages (e.g. in logging approaches), but you can use them together. We are working towards further integrating these two software packages.