sergecroise / osrd Goto Github PK

OSRD is an open source web application for railway infrastructure design, capacity analysis, timetabling and simulation.

It's free and open-source forever!

Learn more about the project on osrd.fr.

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.

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/osrd-compose.sh instead of docker compose to enable host networking - useful to launch services in a debugger)

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

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

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

Copyright © 2022 The OSRD Contributors