This public repository is the community home for JuPedSim Web. It started as an issue tracker and now also contains public documentation, local tooling, shared scenario runtime modules, and example scenarios for running exported setups outside the hosted app.
JuPedSim is a Python package with a C++ core for simulating pedestrian dynamics. JuPedSim Web provides a browser-based interface on top of it, and this repository complements that app with public-facing community and scripting resources.
With JuPedSim Web you can:
- Create, upload, and download simulation scenarios
- Import geometry from DXF and IFC files
- Run pedestrian dynamics simulations
- Visualize results directly in the browser
With this repository you can:
- Report issues and discuss feature ideas
- Run the public Docker setup locally
- Execute public example scenarios from Python
- Reuse mirrored shared scenario logic from the app
- Inspect public V&V assets and workflows
Important
This is still a work in progress! We count on user feedback to enhance the app and add more features in the future.
- Web App: app.jupedsim.org
- JuPedSim Documentation: jupedsim.org
- JuPedSim on GitHub: github.com/PedestrianDynamics/jupedsim
You can run the public JuPedSim Web setup locally:
cd docker
cp .env.example .env
docker compose --env-file .env -f docker-compose.yml up -dSee docker/README.md for the full setup and troubleshooting notes.
The scripts/ directory contains a standalone Python workflow for running exported scenarios locally, including waiting stages, zones, and example scenarios.
uv sync --extra dev
cd scripts
uv run jupyter notebookStart here:
- scripts/README.md
- scripts/core/scenario.py
- scripts/scenarios/
- scripts/bottleneck_zone_nt_diagram.ipynb
docker/contains the public local deployment setup for JuPedSim Web.scripts/contains the local Python runner, notebooks, and example scenarios.shared/contains mirrored public-safe shared modules used by the local scenario runner.tests/vv/contains verification and validation assets and workflows.geometries/contains public geometry examples and format references.
- Found a bug? Open an issue
- Have a feature request? Open an issue
- Need help? Check existing issues or open a new one
- Want to discuss? Use the Discussions tab
Note
The private JuPedSim Web application implementation is not in this repository. This repository contains the public community-facing parts around it.
The app supports DXF and IFC geometry inputs.
For DXF files, use the required layer naming convention:
| Layer Name | Type | Description |
|---|---|---|
| jps-walkablearea | Mandatory | A polyline containing all other simulation elements. No overlaps allowed. |
| jps-obstacles | Optional | Static obstacles within the simulation area |
| jps-distributions | Mandatory | Initial positions/distributions of pedestrians |
| jps-exits | Mandatory | Exit points for pedestrians |
| jps-waypoints | Optional | Intermediate target points for pedestrian navigation |
| jps-journeys | Optional | Predefined paths or routes |
See:
- The walkable area layer must be a closed polyline that encompasses all other elements
- No overlapping geometries are allowed in the walkable area
- Layer names are case-sensitive
When reporting issues, please include:
- Browser and version (e.g., Chrome 120, Firefox 121)
- Operating system (e.g., Windows 11, macOS 14, Ubuntu 22.04)
- Steps to reproduce the issue
- Expected behavior vs. actual behavior
- Screenshots or screen recordings if applicable
- DXF file (if the issue is geometry-related)
This repository is public and community-facing. It is the right place for issues, discussions, docs, local examples, and public scenario tooling. Private backend, web application, and deployment internals remain outside this repository.
This documentation is provided under the MIT License.