PopUpSim Configuration Tutorial¶
This tutorial guides you through installing and configuring PopUpSim using the ten_trains_two_days example scenario. You'll learn about each configuration file, available parameters, and how they affect the simulation.
Tutorial Contents¶
- Installation Guide - Installing Python, uv, and PopUpSim (including non-admin scenarios)
- Overview - Understanding the scenario structure
- Scenario Configuration - Main scenario settings and references
- Topology Configuration - Network nodes and edges
- Track Configuration - Track types and properties
- Workshop Configuration - Workshop setup and capacity
- Process Times Configuration - Operation durations
- Locomotive Configuration - Shunting resources
- Routes Configuration - Movement paths between tracks
- Train Schedule Configuration - Wagon arrivals and properties
- Running Your Simulation - Executing and analyzing results
Quick Start¶
First time user? Start with the Installation Guide to set up Python, uv, and PopUpSim.
To run the example scenario used in this tutorial:
cd dac-migration-dss-popupsim
uv run python popupsim/backend/src/main.py --scenario Data/examples/ten_trains_two_days/ --output output/tutorial/
Scenario Overview¶
The ten_trains_two_days scenario simulates:
- 10 trains arriving over 2 days
- 224 wagons requiring DAC retrofit
- 2 workshops with 2 retrofit stations each
- 15 parking tracks for wagon storage
- 2 collection tracks for incoming trains
- 1 shunting locomotive for wagon movements
This medium-complexity scenario demonstrates realistic workshop operations and helps you understand how to configure your own scenarios.
Learning Path¶
If you're new to PopUpSim: 1. Start with Installation Guide to set up your environment 2. Continue with Overview to understand the file structure 3. Follow the chapters in order to learn each configuration aspect 4. Experiment by modifying values in the example files 5. Run simulations to see how changes affect results
If you're experienced: - Jump to specific chapters for reference - Experiment with different parameter values - Check configuration examples in each chapter
Next Steps¶
Begin with Chapter 0: Installation Guide if you haven't installed PopUpSim yet, or jump to Chapter 1: Overview to understand the scenario structure and file organization.