Skip to main content
Ctrl+K
jupedsim-scenarios  documentation - Home jupedsim-scenarios  documentation - Home
  • GitHub
  • PyPI
Ctrl+K
  • Getting started
  • Concepts
  • Choosing an entrypoint
  • How-tos
    • Quickstart — your first run
    • Coming from vanilla JuPedSim? Same study, two ways
    • How do I see what’s inside a scenario?
    • Visualisation
    • How do I change the number of agents?
    • How do I change the agents’ walking speed?
    • How do I change a zone’s speed factor?
    • How do I set a waiting time on a checkpoint?
    • Why does run_sweep need both axes and apply?
    • How do I persist a sweep and reload it later?
    • How do I sweep over scenario shapes that axes / apply can’t express?
    • How do I build a scenario in pure Python (no JSON editing)?
    • How do I drive a scenario tick-by-tick and inspect it mid-run?
  • Cookbook
    • Working with JuPedSim Web-UI Scenarios in Python
    • Scenario API Demo: Route-Choice Sweep on RiMEA 10
    • From run_scenario to a pedpy density heatmap
    • JuPedSim Model Comparison Sweep
    • Bottleneck N-T Diagram With Zone Speed Factor
    • Faster-Is-Slower Demo
    • Stage Routing in a Square Room
  • CLI reference
  • Troubleshooting
  • API reference
    • jupedsim_scenarios.cli
    • jupedsim_scenarios.direct_steering_runtime
    • jupedsim_scenarios.runner
    • jupedsim_scenarios.simulation_init
    • jupedsim_scenarios.sweep

How-tos

Contents

  • Start here
  • Coming from vanilla JuPedSim
  • Inspecting a scenario
  • Changing agents
  • Routing and zones
  • Parameter sweeps
  • Authoring without the web editor
  • Interactive use

How-tos#

Short, focused notebooks. Each answers one question a newcomer asks after the bottleneck tutorial.

Notebooks are grouped by goal. The filename prefixes (00_, 01_, …) are historical and do not imply a learning order — read whichever section matches what you need to do.

Start here#

  • Quickstart — your first run

Coming from vanilla JuPedSim#

  • Coming from vanilla JuPedSim? Same study, two ways

Inspecting a scenario#

  • How do I see what’s inside a scenario?
  • Visualisation

Changing agents#

  • How do I change the number of agents?
  • How do I change the agents’ walking speed?

Routing and zones#

  • How do I change a zone’s speed factor?
  • How do I set a waiting time on a checkpoint?

Parameter sweeps#

  • Why does run_sweep need both axes and apply?
  • How do I persist a sweep and reload it later?
  • How do I sweep over scenario shapes that axes / apply can’t express?

Authoring without the web editor#

  • How do I build a scenario in pure Python (no JSON editing)?

Interactive use#

  • How do I drive a scenario tick-by-tick and inspect it mid-run?

previous

Choosing an entrypoint

next

Quickstart — your first run

Contents
  • Start here
  • Coming from vanilla JuPedSim
  • Inspecting a scenario
  • Changing agents
  • Routing and zones
  • Parameter sweeps
  • Authoring without the web editor
  • Interactive use

By The JuPedSim Development Team

© Copyright 2026, Forschungszentrum Jülich GmbH, IAS-7.