8000 GitHub - OpenRailAssociation/osrd: An open source web application for railway infrastructure design, capacity analysis, timetabling and simulation
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
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 Translation status REUSE status Openrail Incubation Stage

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.

⚠️ Development status

OSRD is still in active development. User and programming interfaces are not entirely stable and are still occasionally modified. If you rely on OSRD, be prepared to deal with regular changes.

Getting Started

To compile and run the application with an example infrastructure:

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

# import an small example infrastructure ("small_infra")
./scripts/load-railjson-infra.sh small_infra tests/data/infras/small_infra/infra.json

# import rolling stocks with realistic characterics, representative of the industry
./scripts/load-railjson-rolling-stock.sh tests/data/rolling_stocks/realistic/*.json --force

# import more rolling stocks
./scripts/load-railjson-rolling-stock.sh tests/data/rolling_stocks/*.json

<
9AF3
span class="pl-c"># open the web app
xdg-open http://localhost:4000/

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

Working on a single component

Each component has a justfile to run usual developpment tasks. Install just and run it to see available recipes. All the components include:

  • run
  • install
  • test
  • format
  • lint
  • fix-lint

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

0