This source did not publish a separate summary. Review SKILL.md before using the skill.
SKILL.md
SimPy - Discrete-Event Simulation
Overview
SimPy is a process-based discrete-event simulation framework based on standard Python. Use SimPy to model systems where entities (customers, vehicles, packets, etc.) interact with each other and compete for shared resources (servers, machines, bandwidth, etc.) over time.
Capacity planning - Determining optimal resource levels for desired performance
System validation - Testing system behavior before implementation
Not suitable for:
Continuous simulations with fixed time steps (consider SciPy ODE solvers)
Independent processes without resource sharing
Pure mathematical optimization (consider SciPy optimize)
Quick Start
Basic Simulation Structure
import simpy
def process(env, name):
"""A simple process that waits and prints."""
print(f'{name} starting at {env.now}')
yield env.timeout(5)
print(f'{name} finishing at {env.now}')
# Create environment
env = simpy.Environment()
# Start processes
env.process(process(env, 'Process 1'))
env.process(process(env, 'Process 2'))
# Run simulation
env.run(until=10)
Resource Usage Pattern
import simpy
def customer(env, name, resource):
"""Customer requests resource, uses it, then releases."""
with resource.request() as req:
yield req # Wait for resource
print(f'{name} got resource at {env.now}')
yield env.timeout(3) # Use resource
print(f'{name} released resource at {env.now}')
env = simpy.Environment()
server = simpy.Resource(env, capacity=1)
env.process(customer(env, 'Customer 1', server))
env.process(customer(env, 'Customer 2', server))
env.run()
Core Concepts
1. Environment
The simulation environment manages time and schedules events.
import simpy
# Standard environment (runs as fast as possible)
env = simpy.Environment(initial_time=0)
# Real-time environment (synchronized with wall-clock)
import simpy.rt
env_rt = simpy.rt.RealtimeEnvironment(factor=1.0)
# Run simulation
env.run(until=100) # Run until time 100
env.run() # Run until no events remain
2. Processes
Processes are defined using Python generator functions (functions with yield statements).
def my_process(env, param1, param2):
"""Process that yields events to pause execution."""
print(f'Starting at {env.now}')
# Wait for time to pass
yield env.timeout(5)
print(f'Resumed at {env.now}')
# Wait for another event
yield env.timeout(3)
print(f'Done at {env.now}')
return 'result'
# Start the process
env.process(my_process(env, 'value1', 'value2'))
3. Events
Events are the fundamental mechanism for process synchronization. Processes yield events and resume when those events are triggered.
Common event types:
env.timeout(delay) - Wait for time to pass
resource.request() - Request a resource
env.event() - Create a custom event
env.process(func()) - Process as an event
event1 & event2 - Wait for all events (AllOf)
event1 | event2 - Wait for any event (AnyOf)
Resources
SimPy provides several resource types for different scenarios. For comprehensive details, see references/resources.md.
Use monitoring utilities to collect data. See references/monitoring.md for comprehensive techniques.
from scripts.resource_monitor import ResourceMonitor
# Create and monitor resource
resource = simpy.Resource(env, capacity=2)
monitor = ResourceMonitor(env, resource, "Server")
# After simulation
monitor.report()
Step 4: Run and Analyze
# Run simulation
env.run(until=simulation_time)
# Generate reports
monitor.report()
stats.report()
# Export data for further analysis
monitor.export_csv('results.csv')
Advanced Features
Process Interaction
Processes can interact through events, process yields, and interrupts. See references/process-interaction.md for detailed patterns.
Key mechanisms:
Event signaling: Shared events for coordination
Process yields: Wait for other processes to complete
Interrupts: Forcefully resume processes for preemption
Real-Time Simulations
Synchronize simulation with wall-clock time for hardware-in-the-loop or interactive applications. See references/real-time.md.
import simpy.rt
env = simpy.rt.RealtimeEnvironment(factor=1.0) # 1:1 time mapping
# factor=0.5 means 1 sim unit = 0.5 seconds (2x faster)
Comprehensive Monitoring
Monitor processes, resources, and events. See references/monitoring.md for techniques including:
State variable tracking
Resource monkey-patching
Event tracing
Statistical collection
Scripts and Templates
basic_simulation_template.py
Complete template for building queue simulations with: