Skip to content

python-interface and visualization plug-ins for stellwerksim

Notifications You must be signed in to change notification settings

PianoRailways/stskit

 
 

Repository files navigation

stskit

stskit provides a Python interface and visualization plug-ins for Stellwerksim. Stellwerksim is a collaborative online railroad traffic controller simulation game. The stskit project implements a plugin client interface in the Python language providing access to game data for visualization and analysis. The project includes the client code that you can use in your own developments as well as the sts-charts program that may help you to play Stellwerksim more efficiently.

Main features

The plugin client interface exposes the complete Stellwerksim plugin interface in a Python object structure. All client-server communication is asynchronous, based on the trio library.

sts-charts is a graphical demo program with the following components:

  • Detailed track occupancy diagram. Possible conflicts and coupling maneuvers are highlighted. Delays are estimated based on original data and adjusted at long stops.
  • Arrival and departure diagrams
  • Event ticker
  • Network graph (experimental)

The project lays a focus on analyzing original schedule data, effective run times and (as low as possible) user configuration to visualize important data for efficient train disposition.

Requirements and Installation

stskit requires Python 3.8 or higher. The Miniconda distribution is recommended. All required packages are readily available from Conda or PyPI.

For installation, see the Installation page.

License

Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) http://creativecommons.org/licenses/by-nc-sa/4.0/

Contributing

Contributions are welcome in all aspects of the project, most urgently in the development of the Qt-based user interface.

About

python-interface and visualization plug-ins for stellwerksim

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%