Skip to main content

SimASM

Abstract State Machine Framework for Discrete Event Simulation

SimASM is a Python package for modeling, simulating, and verifying discrete event systems using Abstract State Machines (ASM) as a common semantic foundation.

Features

  • DSL for Simulation Models: Write discrete event simulation models in a clean, readable syntax
  • Multiple Formalisms: Support for Event Graph, Activity Cycle Diagram, and DEVS modeling styles
  • Stutter Equivalence Verification: Formally verify that two models produce equivalent observable behavior
  • Jupyter Integration: Interactive modeling with %%simasm magic commands
  • Statistics Collection: Built-in support for time-average, utilization, and count statistics
  • Automatic Plotting: Generate publication-quality plots with confidence intervals, box plots, and time series traces

Installation

pip install simasm

For Jupyter support:

pip install simasm[jupyter]

Quick Start

In Jupyter/Colab

import simasm  # Auto-registers %%simasm magic

Define a model:

%%simasm model --name mm1_queue
domain Event
domain Load

var sim_clocktime: Real
var queue: List<Load>

// ... model definition

Run an experiment:

%%simasm experiment
experiment MyExperiment:
    model := "mm1_queue"

    replication:
        count: 10
        warm_up_time: 100.0
        run_length: 1000.0
    endreplication

    statistics:
        stat AvgQueueLength: time_average
            expression: "lib.length(queue)"
        endstat
    endstatistics
endexperiment

From Python

from simasm.experimenter.engine import ExperimenterEngine

# Run an experiment
engine = ExperimenterEngine("experiments/my_experiment.simasm")
result = engine.run()

print(f"Average queue length: {result['L_queue']}")

Model Syntax

SimASM uses a domain-specific language for defining simulation models:

// Domain declarations
domain Load
domain Server

// Constants and variables
const server: Server
var sim_clocktime: Real
var queue: List<Load>

// Random stream variables
var interarrival_time: rnd.exponential(1.25) as "arrivals"
var service_time: rnd.exponential(1.0) as "service"

// Rules
rule arrive() =
    let load = new Load
    lib.add(queue, load)
    // Schedule next arrival
endrule

// Main rule
main rule main =
    if sim_clocktime < sim_end_time then
        run_routine()
    endif
endrule

// Initial state
init:
    sim_clocktime := 0.0
    queue := []
endinit

Semantics notes

  • Statements in a rule body compose sequentially: each statement sees the updates of the statements before it (unlike standard ASM notation, where parallel composition is the default).
  • forall iterates sequentially in collection order (since 0.9.0): each iteration sees the updates of the previous ones, and a forall equals its unrolled sequential composition. Independent iterations (disjoint written locations, no reads of another iteration's writes) give the same result as the standard parallel forall.
  • par ... endpar gives parallel updates with conflict detection.
  • Legacy: RuleEvaluatorConfig(parallel_forall=True) or SIMASM_PARALLEL_FORALL=1 restores the pre-0.9.0 parallel forall for one release cycle.

See docs/reference/syntax.html for the full statement semantics.

Automatic Plotting

SimASM can automatically generate plots for your experiments with time series traces and statistical analysis:

experiment MyExperiment:
    model := "my_model.simasm"

    replication:
        count: 30
        warm_up_time: 100.0
        run_length: 1000.0
        generate_plots: true      // Enable automatic plotting
        trace_interval: 10.0      // Sample traces every 10 time units
    endreplication

    statistics:
        stat queue_length: time_average
            expression: "lib.length(queue)"
            trace: true           // Capture time series data
        endstat

        stat utilization: time_average
            expression: "busy / capacity"
            trace: true
        endstat
    endstatistics
endexperiment

This automatically generates three types of plots:

  1. Summary Statistics (summary_statistics.png)

    • Bar chart showing mean ± 95% confidence intervals
    • Compares all statistics side-by-side
  2. Box Plots (boxplots.png)

    • Distribution analysis across replications
    • Shows median, quartiles, and outliers
  3. Time Series (timeseries.png)

    • Evolution of statistics over simulation time
    • Mean trace with 95% confidence bands
    • Highlights warmup period

Plots are saved to timestamped directories: simasm/output/YYYY-MM-DD_HH-MM-SS_ExperimentName/

In Jupyter notebooks, plots display inline. From CLI/Python scripts, plots are saved as PNG files.

Verification

SimASM can verify stutter equivalence between two models:

%%simasm verify
verification EG_vs_ACD:
    models:
        import EG from "event_graph_model.simasm"
        import ACD from "acd_model.simasm"
    endmodels

    seed: 42

    labels:
        label queue_empty for EG: "queue_count() == 0"
        label queue_empty for ACD: "queue_count() == 0"
    endlabels

    observables:
        observable queue_empty:
            EG -> queue_empty
            ACD -> queue_empty
        endobservable
    endobservables

    check:
        type: stutter_equivalence
        run_length: 1000.0
    endcheck
endverification

Documentation

License

MIT License - see LICENSE for details.

Citation

If you use SimASM in your research, please cite:

@software{simasm,
  title = {SimASM: Abstract State Machine Framework for Discrete Event Simulation},
  author = {Steve},
  year = {2024},
  url = {https://github.com/yourusername/simasm}
}

Release files for simasm 0.9.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for simasm 0.9.0
File Size Uploaded
simasm-0.9.0.tar.gz 376.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for simasm 0.9.0
File Interpreter ABI Platform
simasm-0.9.0-py3-none-any.whl Python 3 none any Details

Total release size: 749.8 kB

Release files / simasm-0.9.0.tar.gz

Download URL simasm-0.9.0.tar.gz
Size 376.9 kB
Tags Source
SHA-256 checksum
How to use checksums
ca31cdc70f9af4933607fe6b334880361301f255427c82dc4a6d34731304f1e5
BLAKE2b-256 checksum
How to use checksums
940b9998e2b6519f666c47b0ae145049212d97c929c945cfc06b25be24dadb1a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.4

Release files / simasm-0.9.0-py3-none-any.whl

Download URL simasm-0.9.0-py3-none-any.whl
Size 372.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d1ef2839803733bf2890931977ff4a92d48075db4f2c688b0a9378e95e9a950a
BLAKE2b-256 checksum
How to use checksums
b8e005eedd446713bc7fa6adba40deb70276d182d263adb17874464eda34a015
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.4

Release history Release notifications | RSS feed

This release

0.9.0 This release

2 release files

0.8.4

2 release files

0.8.3

2 release files

0.8.2

2 release files

0.8.1

2 release files

0.8.0

2 release files

0.7.0

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.5

2 release files

0.5.4

2 release files

0.5.3

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.9

2 release files

0.4.8

2 release files

0.4.7

2 release files

0.4.6

2 release files

0.4.5

2 release files

0.4.4

2 release files

0.4.3

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.3.9

2 release files

0.3.8

2 release files

0.3.7

2 release files

0.3.6

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.9

2 release files

0.2.8

2 release files

0.2.7

2 release files

0.2.6

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page