Skip to content

An open source web application for railway infrastructure design, capacity analysis, timetabling and simulation

Notifications You must be signed in to change notification settings

OpenRailAssociation/osrd

Repository files navigation

OSRD Logo    Public Money Public Code

Contributors badge LGPL License badge Build Status

What is OSRD?

OSRD (Open Source Railway Designer) is an open source web application for railway infrastructure design, capacity analysis, timetabling and simulation and short term path request.

It's free and open-source forever!

Learn more about the project on osrd.fr.

WARNING

OSRD it not yet production ready. User and programming interfaces can and will change (now is the time to make suggestions!). Important features are missing. Documentation is sparse. Please don't rely on OSRD unless you are prepared to deal with frequent changes.

Getting Started

To compile and run the application with an example infrastructure:

# build and run the entire stack
docker compose up -d --build

./scripts/load-railjson-infra.sh small_infra tests/data/infras/small_infra/infra.json
./scripts/load-railjson-rolling-stock.sh tests/data/rolling_stocks/*.json

# open the web app
xdg-open http://localhost:4000/

(Linux or WSL users can use scripts/host-compose.sh instead of docker compose to enable host networking - useful to launch services in a debugger)

Deployment

To deploy the application on a server, check out the deployment guide.

Get in touch

Send an email at contact@osrd.fr, open an issue, or join the #public-general:osrd.fr matrix channel.

Sponsors

Ministère chargé des Transports European Union SNCF Réseau

License

OSRD is licensed under the GNU Lesser General Public License v3.0, see LICENSE.

Copyright © 2022 The OSRD Contributors