User Guide

These pages explain how to use UPSTAGE’s primary features with examples.

Some simple simulations are created that demonstrate the basic features, and then each main UPSTAGE feature is covered in depth.

First, UPSTAGE lets you create Actors and modify the States of those actors through Tasks, which are assembled into TaskNetworks that allow control flow of the tasks.

States have multiple features that allow them to be time-varying while respecting discrete event behavior, along with being recordable. More advanced features include “mimicking” other states.

Tasks and their networks can interacted with in multiple ways, and UPSTAGE provides Nucleus and Interrupt handling to support that.

There are also several convenience features for simulation building and running, including entity naming, geographic functions and states, and safe global variables in an environment context manager.

Starting Point

These tutorials cover the core features of Actors, States, Tasks, and Task Networks. The final tutorial is a comparison of SimPy and UPSTAGE which will help motivate why UPSTAGE was created.

Tutorials

• First UPSTAGE Simulation
• Task Interrupts
• Task Rehearsal
• Best Practices
• UPSTAGE vs SimPy

It is also recommended that you familiarize yourself with how SimPy runs by itself, since UPSTAGE is a layer on top of that library.

Full Examples

These are complete examples for some of the above tutorials.

Full Examples

• First Simulation Full Source
• Rehearsal Simulation Example
• Complex Cashier Full Source

How-to Guides

These pages detail the specific activities that can be accomplished using UPSTAGE, including how to extend UPSTAGE’s features.

How-Tos

• Resource States
• Active States
• Mimic States
• Task Nucleus
• Stage Variables
• Events
• Geography
• Decision Tasks
• Task Networks
• State Sharing
• Named Entities
• Motion Manager
• Communications
• Typing and UPSTAGE
• Random Numbers