## What is OSRD?
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](https://osrd.fr/en/).
## 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:
```sh
# 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)
## Deployment
To deploy the application on a server, check out the [deployment guide](https://osrd.fr/en/docs/guides/deploy/).
## Get in touch
Send an email at , [open an issue](https://github.com/OpenRailAssociation/osrd/issues/new?labels=kind%3Aquestion&template=question.yaml), or join the [#public-general:osrd.fr](https://matrix.to/#/#public-general:osrd.fr) matrix channel.
## Sponsors
