simasm 0.1.0__tar.gz

simasm-0.1.0/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.1.0/PKG-INFO

@@ -0,0 +1,207 @@
+Metadata-Version: 2.2
+Name: simasm
+Version: 0.1.0
+Summary: Abstract State Machine Framework for Discrete Event Simulation
+Author: Steve
+License: MIT
+Project-URL: Homepage, https://github.com/stevenaeola/simasm
+Project-URL: Documentation, https://github.com/stevenaeola/simasm#readme
+Project-URL: Repository, https://github.com/stevenaeola/simasm
+Project-URL: Issues, https://github.com/stevenaeola/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
+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
+
+## 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
+```
+
+## 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.1.0/README.md

@@ -0,0 +1,170 @@
+# 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
+
+## 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
+```
+
+## 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.1.0/pyproject.toml

@@ -0,0 +1,65 @@
+[build-system]
+requires = ["setuptools>=61.0,<77.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "simasm"
+version = "0.1.0"
+description = "Abstract State Machine Framework for Discrete Event Simulation"
+readme = "README.md"
+license = {text = "MIT"}
+authors = [
+    {name = "Steve"}
+]
+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",
+]
+
+[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://github.com/stevenaeola/simasm"
+Documentation = "https://github.com/stevenaeola/simasm#readme"
+Repository = "https://github.com/stevenaeola/simasm"
+Issues = "https://github.com/stevenaeola/simasm/issues"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["simasm*"]
+
+[tool.setuptools.package-data]
+simasm = ["parser/*.lark", "experimenter/*.lark"]
+
+[tool.pytest.ini_options]
+testpaths = ["test"]
+python_files = ["test_*.py"]
+addopts = "-v"

simasm-0.1.0/setup.cfg

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

simasm-0.1.0/simasm/__init__.py

@@ -0,0 +1,45 @@
+"""
+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 in Jupyter/Colab:
+    import simasm  # Auto-registers %%simasm magic
+
+    %%simasm model --name mm1_queue
+    domain Event
+    ...
+
+    %%simasm experiment
+    experiment Test:
+        model := "mm1_queue"
+        ...
+    endexperiment
+
+    %%simasm verify
+    verification Check:
+        ...
+    endverification
+"""
+
+__version__ = "0.1.0"
+__author__ = "Steve"
+
+
+# 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()

simasm-0.1.0/simasm/config/__init__.py

@@ -0,0 +1,7 @@
+"""
+SimASM configuration module.
+"""
+
+from .file_config import FileConfig
+
+__all__ = ['FileConfig']

simasm-0.1.0/simasm/config/file_config.py

@@ -0,0 +1,59 @@
+"""
+config/file_config.py
+
+Centralized file path configuration for SimASM.
+"""
+
+import os
+
+# Project root is one level up from config/
+PROJECT_ROOT = os.path.dirname(os.path.abspath(os.path.join(__file__, '../')))
+
+
+class FileConfig:
+    """
+    Central configuration for all file paths in SimASM.
+    
+    Usage:
+        from simasm.config.file_config import FileConfig
+        
+        log_file = os.path.join(FileConfig.log_path, 'run.log')
+    """
+    
+    # Root path
+    root_path = PROJECT_ROOT
+    
+    # Main package paths
+    config_path = os.path.join(PROJECT_ROOT, 'config')
+    core_path = os.path.join(PROJECT_ROOT, 'core')
+    experimenter_path = os.path.join(PROJECT_ROOT, 'experimenter')
+    jupyter_path = os.path.join(PROJECT_ROOT, 'jupyter')
+    log_path = os.path.join(PROJECT_ROOT, 'log')
+    parser_path = os.path.join(PROJECT_ROOT, 'parser')
+    runtime_path = os.path.join(PROJECT_ROOT, 'runtime')
+    verification_path = os.path.join(PROJECT_ROOT, 'verification')
+    
+    # I/O paths
+    input_path = os.path.join(PROJECT_ROOT, 'input')
+    output_path = os.path.join(PROJECT_ROOT, 'output')
+    
+    # Test paths (outside main package)
+    test_path = os.path.join(os.path.dirname(PROJECT_ROOT), 'test')
+    test_input_path = os.path.join(test_path, 'input')
+    test_output_path = os.path.join(test_path, 'output')
+    test_log_path = os.path.join(test_path, 'log')
+    
+    @classmethod
+    def ensure_directories(cls) -> None:
+        """Create all directories if they don't exist."""
+        directories = [
+            cls.log_path,
+            cls.input_path,
+            cls.output_path,
+            cls.test_path,
+            cls.test_input_path,
+            cls.test_output_path,
+            cls.test_log_path,
+        ]
+        for directory in directories:
+            os.makedirs(directory, exist_ok=True)

simasm-0.1.0/simasm/core/__init__.py

@@ -0,0 +1,51 @@
+"""
+SimASM core module.
+
+Contains fundamental ASM constructs:
+- types: Domain and type hierarchy
+- state: ASM state representation
+- update: Update and UpdateSet
+- terms: Term/expression evaluation
+- rules: Rule evaluation
+"""
+
+from .types import Domain, TypeRegistry, BUILTIN_TYPES
+from .state import UNDEF, Undefined, ASMObject, Location, ASMState
+from .update import Update, UpdateConflictError, UpdateSet
+from .terms import (
+    Environment,
+    Term, LiteralTerm, VariableTerm, LocationTerm,
+    BinaryOpTerm, UnaryOpTerm, ListTerm, TupleTerm, NewTerm,
+    LibCallTerm, RndCallTerm, ConditionalTerm,
+    TermEvaluator, TermEvaluationError,
+)
+from .rules import (
+    Stmt, SkipStmt, UpdateStmt, SeqStmt, IfStmt,
+    WhileStmt, ForallStmt, LetStmt, RuleCallStmt, PrintStmt,
+    ChooseStmt, ParStmt, LibCallStmt, RndCallStmt,
+    RuleDefinition, RuleRegistry,
+    RuleEvaluator, RuleEvaluatorConfig,
+    RuleEvaluationError, InfiniteLoopError, MaxRecursionError,
+)
+
+__all__ = [
+    # types
+    'Domain', 'TypeRegistry', 'BUILTIN_TYPES',
+    # state
+    'UNDEF', 'Undefined', 'ASMObject', 'Location', 'ASMState',
+    # update
+    'Update', 'UpdateConflictError', 'UpdateSet',
+    # terms
+    'Environment',
+    'Term', 'LiteralTerm', 'VariableTerm', 'LocationTerm',
+    'BinaryOpTerm', 'UnaryOpTerm', 'ListTerm', 'TupleTerm', 'NewTerm',
+    'LibCallTerm', 'RndCallTerm', 'ConditionalTerm',
+    'TermEvaluator', 'TermEvaluationError',
+    # rules
+    'Stmt', 'SkipStmt', 'UpdateStmt', 'SeqStmt', 'IfStmt',
+    'WhileStmt', 'ForallStmt', 'LetStmt', 'RuleCallStmt', 'PrintStmt',
+    'ChooseStmt', 'ParStmt', 'LibCallStmt', 'RndCallStmt',
+    'RuleDefinition', 'RuleRegistry',
+    'RuleEvaluator', 'RuleEvaluatorConfig',
+    'RuleEvaluationError', 'InfiniteLoopError', 'MaxRecursionError',
+]