simasm 0.3.4__tar.gz

simasm-0.3.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Steve Yeo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

simasm-0.3.4/PKG-INFO

@@ -0,0 +1,261 @@
+Metadata-Version: 2.2
+Name: simasm
+Version: 0.3.4
+Summary: Abstract State Machine Framework for Discrete Event Simulation
+Author: Steve Yeo
+License: MIT
+Project-URL: Homepage, https://simasm-project.github.io/
+Project-URL: Documentation, https://simasm-project.github.io/reference/syntax.html/
+Project-URL: Repository, https://github.com/SimASM-Project
+Project-URL: Issues, https://github.com/SimASM-Project/simasm/issues
+Keywords: simulation,discrete-event,state-machine,verification,event-graph,activity-cycle-diagram,stutter-equivalence
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Software Development :: Interpreters
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: lark>=1.1.0
+Requires-Dist: pydantic>=2.0
+Requires-Dist: numpy>=1.20
+Requires-Dist: matplotlib>=3.5
+Requires-Dist: scipy>=1.9
+Provides-Extra: jupyter
+Requires-Dist: ipython>=7.0; extra == "jupyter"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: build>=1.0; extra == "dev"
+Requires-Dist: twine>=4.0; extra == "dev"
+Provides-Extra: all
+Requires-Dist: simasm[dev,jupyter]; extra == "all"
+
+# 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 and Activity Cycle Diagram 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
+
+```bash
+pip install simasm
+```
+
+For Jupyter support:
+```bash
+pip install simasm[jupyter]
+```
+
+## Quick Start
+
+### In Jupyter/Colab
+
+```python
+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
+
+```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:
+
+```simasm
+// 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
+```
+
+## Automatic Plotting
+
+SimASM can automatically generate plots for your experiments with time series traces and statistical analysis:
+
+```simasm
+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
+
+- [Full Documentation](https://github.com/yourusername/simasm)
+- [Examples](https://github.com/yourusername/simasm/tree/main/examples)
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+## Citation
+
+If you use SimASM in your research, please cite:
+
+```bibtex
+@software{simasm,
+  title = {SimASM: Abstract State Machine Framework for Discrete Event Simulation},
+  author = {Steve},
+  year = {2024},
+  url = {https://github.com/yourusername/simasm}
+}
+```

simasm-0.3.4/README.md

@@ -0,0 +1,220 @@
+# 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 and Activity Cycle Diagram 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
+
+```bash
+pip install simasm
+```
+
+For Jupyter support:
+```bash
+pip install simasm[jupyter]
+```
+
+## Quick Start
+
+### In Jupyter/Colab
+
+```python
+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
+
+```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:
+
+```simasm
+// 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
+```
+
+## Automatic Plotting
+
+SimASM can automatically generate plots for your experiments with time series traces and statistical analysis:
+
+```simasm
+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
+
+- [Full Documentation](https://github.com/yourusername/simasm)
+- [Examples](https://github.com/yourusername/simasm/tree/main/examples)
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+## Citation
+
+If you use SimASM in your research, please cite:
+
+```bibtex
+@software{simasm,
+  title = {SimASM: Abstract State Machine Framework for Discrete Event Simulation},
+  author = {Steve},
+  year = {2024},
+  url = {https://github.com/yourusername/simasm}
+}
+```

simasm-0.3.4/pyproject.toml

@@ -0,0 +1,69 @@
+[build-system]
+requires = ["setuptools>=61.0,<77.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "simasm"
+version = "0.3.4"
+description = "Abstract State Machine Framework for Discrete Event Simulation"
+readme = "README.md"
+license = {text = "MIT"}
+authors = [
+    {name = "Steve Yeo"}
+]
+requires-python = ">=3.9"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Scientific/Engineering :: Mathematics",
+    "Topic :: Software Development :: Interpreters",
+]
+keywords = ["simulation", "discrete-event", "state-machine", "verification", "event-graph", "activity-cycle-diagram", "stutter-equivalence"]
+
+dependencies = [
+    "lark>=1.1.0",
+    "pydantic>=2.0",
+    "numpy>=1.20",
+    "matplotlib>=3.5",
+    "scipy>=1.9",
+]
+
+[project.optional-dependencies]
+jupyter = [
+    "ipython>=7.0",
+]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+    "build>=1.0",
+    "twine>=4.0",
+]
+all = [
+    "simasm[jupyter,dev]",
+]
+
+[project.urls]
+Homepage = "https://simasm-project.github.io/"
+Documentation = "https://simasm-project.github.io/reference/syntax.html/"
+Repository = "https://github.com/SimASM-Project"
+Issues = "https://github.com/SimASM-Project/simasm/issues"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["simasm*"]
+
+[tool.setuptools.package-data]
+simasm = ["parser/*.lark", "experimenter/*.lark", "converter/*.lark"]
+
+[tool.pytest.ini_options]
+testpaths = ["test"]
+python_files = ["test_*.py"]
+addopts = "-v"

simasm-0.3.4/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

simasm-0.3.4/simasm/__init__.py

@@ -0,0 +1,84 @@
+"""
+SimASM - Abstract State Machine Framework for Discrete Event Simulation
+
+A Python package for modeling, simulating, and verifying discrete event
+systems using Abstract State Machines as the common semantic foundation.
+
+Usage with Python API (recommended - avoids linter warnings):
+    import simasm
+
+    # Define models as strings
+    simasm.register_model("mm1_eg", '''
+    domain Object
+    ...
+    ''')
+
+    # Run experiments
+    result = simasm.run_experiment('''
+    experiment Test:
+        model := "mm1_eg"
+        ...
+    endexperiment
+    ''')
+
+    # Run verifications
+    result = simasm.verify('''
+    verification Check:
+        models:
+            import EG from "mm1_eg"
+            ...
+        endmodels
+        ...
+    endverification
+    ''')
+
+Alternative: Jupyter/Colab cell magics:
+    import simasm  # Auto-registers %%simasm magic
+
+    %%simasm model --name mm1_queue
+    domain Event
+    ...
+"""
+
+__version__ = "0.3.4"
+__author__ = "Steve Yeo"
+
+
+# Import Python API functions for direct access
+from simasm.api import (
+    # Model registry
+    register_model,
+    get_model,
+    list_models,
+    clear_models,
+    unregister_model,
+    # Experiment/verification
+    run_experiment,
+    verify,
+    # Direct execution
+    run_model,
+    parse_model,
+    # Conversion
+    convert_model,
+    # Display helpers
+    display_experiment_result,
+    display_verification_result,
+)
+
+
+# Auto-register Jupyter magics when imported in IPython/Jupyter
+def _register_jupyter_magics():
+    """Auto-register magics if running in IPython/Jupyter."""
+    try:
+        from IPython import get_ipython
+        ipython = get_ipython()
+        if ipython is not None:
+            from simasm.jupyter.magic import SimASMMagics
+            ipython.register_magics(SimASMMagics)
+    except ImportError:
+        pass  # IPython not installed
+    except Exception:
+        pass  # Not in IPython environment or other error
+
+
+_register_jupyter_magics()