mi-mx 0.1.0__tar.gz

mi_mx-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Leon Starr
+
+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.

mi_mx-0.1.0/MANIFEST.in

@@ -0,0 +1 @@
+include src/mx/log.conf

mi_mx-0.1.0/PKG-INFO

@@ -0,0 +1,142 @@
+Metadata-Version: 2.4
+Name: mi-mx
+Version: 0.1.0
+Summary: Shlaer-Mellor Executable UML Model Execution Environment
+Author-email: Leon Starr <leon_starr@modelint.com>
+License: MIT License
+        
+        Copyright (c) 2025 Leon Starr
+        
+        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.
+        
+Project-URL: repository, https://github.com/modelint/model-execution
+Project-URL: documentation, https://github.com/modelint/model-execution/wiki
+Keywords: shlaer-mellor,metamodel,executable uml,mbse,xuml,xtuml,platform independent,sysml
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: xcm-parser
+Requires-Dist: xsm-parser
+Requires-Dist: mi-configurator
+Requires-Dist: mi-pyral
+Requires-Dist: sip-parser
+Requires-Dist: PyYAML
+Requires-Dist: tomli; python_version < "3.13"
+Provides-Extra: build
+Requires-Dist: build; extra == "build"
+Requires-Dist: twine; extra == "build"
+Provides-Extra: dev
+Requires-Dist: bump2version; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Dynamic: license-file
+
+## Model execution engine
+
+# Loading a System
+
+We supply mx with a system to run, an initial context, and a scenario to execute
+
+`mx -s elevator -c three_bank1 -x lobby_to_three`
+
+The required arguments are:
+
+```
+-s / --system
+-c / --context
+-x / --scenario
+```
+Optional arguments are:
+```
+-D / --debug
+-V / --version
+```
+### -s or --system
+
+Here you specify the name of a directory containing the following components:
+```
+system_name/
+    system.ral   - Metamodel produced by xuml-populate (can be named anything you like, with any extension)
+    db_types/    - Directory of yaml files mapping user types to TclRAL system types (must have this name)
+        domain_name1_types.yaml  - Each yaml file name must begin with domain name or alias
+        domain_name2_types.yaml
+        domain_name3_types.yaml
+```
+Example:
+```
+elevator/                 - Any name ok
+    elevator.ral          - Any name ok, ev.txt, mm3.ral, etc.
+    db_types/             - Must be this name
+        evman_types.yaml  - could have named it evman.yaml, elevator_management.yaml, 
+                          - evman_user_to_tcl_types.yaml, etc
+                          - but prefix must be either evman (alias) or elevator_management
+                          - case insensitive, so EVMAN also okay
+```
+
+
+The `system.ral` file is actually just a text file serialization of a TclRAL database.
+Specifically, it is a populated SM Metamodel that you can generate with the xuml-populate tool.  The metamodel is populated with one or more modeled domains. In our example, this is the elevator management domain. We could also add in the transport and sio domains defined in the elevator case study if we like, but for now we just have the elevator management (EVMAN) domain.
+
+### -c or --context
+
+This is yet another directory that contains a single initial context per domain. It is structured like this:
+```
+context_name/    - Any name that describes your aggregate initial context
+     domain1.sip - One initial population per domain in the system
+     domain2.sip
+     domain3.sip
+```
+
+An initial context is a population of initial instances and states. That way we can begin a scenario with a known set of instances in known states for those instances with modeled lifecycles (state machines).
+
+Each domain's context is defined with a single *.sip (scenario instance population) file.
+
+In our example we have only one domain population:
+```
+three_bank/
+     evman_three_bank1.sip
+```
+We named it 'three_bank' since we are using three separate elevator banks, 'lower floors',
+'express', and 'freight'.
+
+If we were running the trans and sio domains, we could have supplied one *.sip file for each
+in this directory as well.
+
+Note that each *.sip file name must begin with a domain name or alias.
+
+See the sip-parser repository wiki for details on the grammar.
+
+MX invokes the sip-parser when it loads the file and will throw any errors it finds in the process.
+
+### -x or --scenario
+
+Finally, we provide a sequence of interactions in the form of a scenario file to run against the populated system.
+
+This is specified in a *.scn file. *(grammar/parser yet to be designed)*
+
+You use the sequence of interactions to drive validation or exploration.
+
+For example, you might specify that a cabin going up is requested from the lobby floor 
+in the lower floors bank. It arrives, floor 3 is requested, the doors close, the cabin transits and then arrives at that floor with the doors opening.
+
+This scenario will result in the appropriate events signaled in the loaded system and collect any responses and status updates of interest along the way.
+
+You can define multiple initial contexts for a system and run the same or different scenarios against each.

mi_mx-0.1.0/README.md

@@ -0,0 +1,91 @@
+## Model execution engine
+
+# Loading a System
+
+We supply mx with a system to run, an initial context, and a scenario to execute
+
+`mx -s elevator -c three_bank1 -x lobby_to_three`
+
+The required arguments are:
+
+```
+-s / --system
+-c / --context
+-x / --scenario
+```
+Optional arguments are:
+```
+-D / --debug
+-V / --version
+```
+### -s or --system
+
+Here you specify the name of a directory containing the following components:
+```
+system_name/
+    system.ral   - Metamodel produced by xuml-populate (can be named anything you like, with any extension)
+    db_types/    - Directory of yaml files mapping user types to TclRAL system types (must have this name)
+        domain_name1_types.yaml  - Each yaml file name must begin with domain name or alias
+        domain_name2_types.yaml
+        domain_name3_types.yaml
+```
+Example:
+```
+elevator/                 - Any name ok
+    elevator.ral          - Any name ok, ev.txt, mm3.ral, etc.
+    db_types/             - Must be this name
+        evman_types.yaml  - could have named it evman.yaml, elevator_management.yaml, 
+                          - evman_user_to_tcl_types.yaml, etc
+                          - but prefix must be either evman (alias) or elevator_management
+                          - case insensitive, so EVMAN also okay
+```
+
+
+The `system.ral` file is actually just a text file serialization of a TclRAL database.
+Specifically, it is a populated SM Metamodel that you can generate with the xuml-populate tool.  The metamodel is populated with one or more modeled domains. In our example, this is the elevator management domain. We could also add in the transport and sio domains defined in the elevator case study if we like, but for now we just have the elevator management (EVMAN) domain.
+
+### -c or --context
+
+This is yet another directory that contains a single initial context per domain. It is structured like this:
+```
+context_name/    - Any name that describes your aggregate initial context
+     domain1.sip - One initial population per domain in the system
+     domain2.sip
+     domain3.sip
+```
+
+An initial context is a population of initial instances and states. That way we can begin a scenario with a known set of instances in known states for those instances with modeled lifecycles (state machines).
+
+Each domain's context is defined with a single *.sip (scenario instance population) file.
+
+In our example we have only one domain population:
+```
+three_bank/
+     evman_three_bank1.sip
+```
+We named it 'three_bank' since we are using three separate elevator banks, 'lower floors',
+'express', and 'freight'.
+
+If we were running the trans and sio domains, we could have supplied one *.sip file for each
+in this directory as well.
+
+Note that each *.sip file name must begin with a domain name or alias.
+
+See the sip-parser repository wiki for details on the grammar.
+
+MX invokes the sip-parser when it loads the file and will throw any errors it finds in the process.
+
+### -x or --scenario
+
+Finally, we provide a sequence of interactions in the form of a scenario file to run against the populated system.
+
+This is specified in a *.scn file. *(grammar/parser yet to be designed)*
+
+You use the sequence of interactions to drive validation or exploration.
+
+For example, you might specify that a cabin going up is requested from the lobby floor 
+in the lower floors bank. It arrives, floor 3 is requested, the doors close, the cabin transits and then arrives at that floor with the doors opening.
+
+This scenario will result in the appropriate events signaled in the loaded system and collect any responses and status updates of interest along the way.
+
+You can define multiple initial contexts for a system and run the same or different scenarios against each.

mi_mx-0.1.0/pyproject.toml

@@ -0,0 +1,30 @@
+[build-system]
+requires      = ["setuptools>=61.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "mi-mx"
+version = "0.1.0"
+description = "Shlaer-Mellor Executable UML Model Execution Environment"
+readme = "README.md"
+authors = [{ name = "Leon Starr", email = "leon_starr@modelint.com" }]
+license = { file = "LICENSE" }
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+]
+keywords = ["shlaer-mellor", "metamodel", "executable uml", "mbse", "xuml", "xtuml", "platform independent", "sysml"]
+dependencies = ["xcm-parser", "xsm-parser", "mi-configurator", "mi-pyral", "sip-parser", "PyYAML", 'tomli; python_version < "3.13"']
+requires-python = ">=3.11"
+
+[project.optional-dependencies]
+build = ["build", "twine"]
+dev = ["bump2version", "pytest"]
+
+[project.scripts]
+mx = "mx.__main__:main"
+
+[project.urls]
+repository    = "https://github.com/modelint/model-execution"
+documentation = "https://github.com/modelint/model-execution/wiki"

mi_mx-0.1.0/setup.cfg

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

mi_mx-0.1.0/src/mi_mx.egg-info/PKG-INFO

@@ -0,0 +1,142 @@
+Metadata-Version: 2.4
+Name: mi-mx
+Version: 0.1.0
+Summary: Shlaer-Mellor Executable UML Model Execution Environment
+Author-email: Leon Starr <leon_starr@modelint.com>
+License: MIT License
+        
+        Copyright (c) 2025 Leon Starr
+        
+        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.
+        
+Project-URL: repository, https://github.com/modelint/model-execution
+Project-URL: documentation, https://github.com/modelint/model-execution/wiki
+Keywords: shlaer-mellor,metamodel,executable uml,mbse,xuml,xtuml,platform independent,sysml
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: xcm-parser
+Requires-Dist: xsm-parser
+Requires-Dist: mi-configurator
+Requires-Dist: mi-pyral
+Requires-Dist: sip-parser
+Requires-Dist: PyYAML
+Requires-Dist: tomli; python_version < "3.13"
+Provides-Extra: build
+Requires-Dist: build; extra == "build"
+Requires-Dist: twine; extra == "build"
+Provides-Extra: dev
+Requires-Dist: bump2version; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Dynamic: license-file
+
+## Model execution engine
+
+# Loading a System
+
+We supply mx with a system to run, an initial context, and a scenario to execute
+
+`mx -s elevator -c three_bank1 -x lobby_to_three`
+
+The required arguments are:
+
+```
+-s / --system
+-c / --context
+-x / --scenario
+```
+Optional arguments are:
+```
+-D / --debug
+-V / --version
+```
+### -s or --system
+
+Here you specify the name of a directory containing the following components:
+```
+system_name/
+    system.ral   - Metamodel produced by xuml-populate (can be named anything you like, with any extension)
+    db_types/    - Directory of yaml files mapping user types to TclRAL system types (must have this name)
+        domain_name1_types.yaml  - Each yaml file name must begin with domain name or alias
+        domain_name2_types.yaml
+        domain_name3_types.yaml
+```
+Example:
+```
+elevator/                 - Any name ok
+    elevator.ral          - Any name ok, ev.txt, mm3.ral, etc.
+    db_types/             - Must be this name
+        evman_types.yaml  - could have named it evman.yaml, elevator_management.yaml, 
+                          - evman_user_to_tcl_types.yaml, etc
+                          - but prefix must be either evman (alias) or elevator_management
+                          - case insensitive, so EVMAN also okay
+```
+
+
+The `system.ral` file is actually just a text file serialization of a TclRAL database.
+Specifically, it is a populated SM Metamodel that you can generate with the xuml-populate tool.  The metamodel is populated with one or more modeled domains. In our example, this is the elevator management domain. We could also add in the transport and sio domains defined in the elevator case study if we like, but for now we just have the elevator management (EVMAN) domain.
+
+### -c or --context
+
+This is yet another directory that contains a single initial context per domain. It is structured like this:
+```
+context_name/    - Any name that describes your aggregate initial context
+     domain1.sip - One initial population per domain in the system
+     domain2.sip
+     domain3.sip
+```
+
+An initial context is a population of initial instances and states. That way we can begin a scenario with a known set of instances in known states for those instances with modeled lifecycles (state machines).
+
+Each domain's context is defined with a single *.sip (scenario instance population) file.
+
+In our example we have only one domain population:
+```
+three_bank/
+     evman_three_bank1.sip
+```
+We named it 'three_bank' since we are using three separate elevator banks, 'lower floors',
+'express', and 'freight'.
+
+If we were running the trans and sio domains, we could have supplied one *.sip file for each
+in this directory as well.
+
+Note that each *.sip file name must begin with a domain name or alias.
+
+See the sip-parser repository wiki for details on the grammar.
+
+MX invokes the sip-parser when it loads the file and will throw any errors it finds in the process.
+
+### -x or --scenario
+
+Finally, we provide a sequence of interactions in the form of a scenario file to run against the populated system.
+
+This is specified in a *.scn file. *(grammar/parser yet to be designed)*
+
+You use the sequence of interactions to drive validation or exploration.
+
+For example, you might specify that a cabin going up is requested from the lobby floor 
+in the lower floors bank. It arrives, floor 3 is requested, the doors close, the cabin transits and then arrives at that floor with the doors opening.
+
+This scenario will result in the appropriate events signaled in the loaded system and collect any responses and status updates of interest along the way.
+
+You can define multiple initial contexts for a system and run the same or different scenarios against each.

mi_mx-0.1.0/src/mi_mx.egg-info/SOURCES.txt

@@ -0,0 +1,59 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+src/mi_mx.egg-info/PKG-INFO
+src/mi_mx.egg-info/SOURCES.txt
+src/mi_mx.egg-info/dependency_links.txt
+src/mi_mx.egg-info/entry_points.txt
+src/mi_mx.egg-info/requires.txt
+src/mi_mx.egg-info/top_level.txt
+src/mx/__init__.py
+src/mx/__main__.py
+src/mx/activity.py
+src/mx/assigner_state_machine.py
+src/mx/completion_event.py
+src/mx/db_names.py
+src/mx/dispatched_event.py
+src/mx/domain.py
+src/mx/exceptions.py
+src/mx/file_names.py
+src/mx/initial_states.py
+src/mx/instance.py
+src/mx/instance_set.py
+src/mx/interaction_event.py
+src/mx/lifecycle_state_machine.py
+src/mx/log.conf
+src/mx/method.py
+src/mx/multiple_assigner_state_machine.py
+src/mx/mx_logger.py
+src/mx/mxtypes.py
+src/mx/operation.py
+src/mx/rvname.py
+src/mx/scenario.py
+src/mx/single_assigner_state_machine.py
+src/mx/state_activity.py
+src/mx/state_machine.py
+src/mx/system.py
+src/mx/xe.py
+src/mx/actions/__init__.py
+src/mx/actions/action.py
+src/mx/actions/extract.py
+src/mx/actions/flow.py
+src/mx/actions/gate.py
+src/mx/actions/project.py
+src/mx/actions/rank_restrict.py
+src/mx/actions/read.py
+src/mx/actions/rename.py
+src/mx/actions/restrict.py
+src/mx/actions/scalar_switch.py
+src/mx/actions/select.py
+src/mx/actions/set_action.py
+src/mx/actions/signal.py
+src/mx/actions/single_select.py
+src/mx/actions/traverse.py
+src/mx/actions/zero_one_card_select.py
+src/mx/deprecated/__init__.py
+src/mx/deprecated/bridge.py
+src/mx/scenarios/__init__.py
+src/mx/scenarios/ev_scenario_REF.py

mi_mx-0.1.0/src/mi_mx.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

mi_mx-0.1.0/src/mi_mx.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+mx = mx.__main__:main

mi_mx-0.1.0/src/mi_mx.egg-info/requires.txt

@@ -0,0 +1,17 @@
+xcm-parser
+xsm-parser
+mi-configurator
+mi-pyral
+sip-parser
+PyYAML
+
+[:python_version < "3.13"]
+tomli
+
+[build]
+build
+twine
+
+[dev]
+bump2version
+pytest

mi_mx-0.1.0/src/mi_mx.egg-info/top_level.txt

@@ -0,0 +1 @@
+mx

mi_mx-0.1.0/src/mx/__init__.py

@@ -0,0 +1 @@
+version = "0.1.0"

mi_mx-0.1.0/src/mx/__main__.py

@@ -0,0 +1,81 @@
+"""
+Blueprint Model Execution
+
+"""
+# System
+import logging
+import logging.config
+import sys
+import argparse
+from pathlib import Path
+import atexit
+
+# MX
+from mx.xe import XE
+from mx import version
+
+_logpath = Path("mx.log")
+_progname = 'Blueprint Model Execution'
+
+def clean_up():
+    """Normal and exception exit activities"""
+    _logpath.unlink(missing_ok=True)
+
+def get_logger():
+    """Initiate the logger"""
+    log_conf_path = Path(__file__).parent / 'log.conf'  # Logging configuration is in this file
+    logging.config.fileConfig(fname=log_conf_path, disable_existing_loggers=False)
+    return logging.getLogger(__name__)  # Create a logger for this module
+
+
+# Configure the expected parameters and actions for the argparse module
+def parse(cl_input):
+    parser = argparse.ArgumentParser(description=_progname)
+    parser.add_argument('-s', '--system', action='store',
+                        help='Name of the metamodel TclRAL database *.ral file populated with one or more domains')
+    parser.add_argument('-c', '--context', action='store',
+                        help='Name of the context directory specifying the initialized domain dbs and a *.sip file')
+    parser.add_argument('-x', '--scenario', action='store',
+                        help='Name of the scenario *.yaml file to run against the populated system')
+    parser.add_argument('-D', '--debug', action='store_true',
+                        help='Debug mode'),
+    parser.add_argument('-L', '--log', action='store_true',
+                        help='Generate a diagnostic log file')
+    parser.add_argument('-v', '--verbose', action='store_true',
+                        help='Verbose messages')
+    parser.add_argument('-V', '--version', action='store_true',
+                        help='Print the current version of the model execution app')
+    return parser.parse_args(cl_input)
+
+
+def main():
+    # Start logging
+    logger = get_logger()
+    logger.info(f'{_progname} version: {version}')
+
+    # Parse the command line args
+    args = parse(sys.argv[1:])
+
+    if args.version:
+        # Just print the version and quit
+        print(f'{_progname} version: {version}')
+        sys.exit(0)
+
+    if not args.log:
+        # If no log file is requested, remove the log file before termination
+        atexit.register(clean_up)
+
+    # Domain specified
+    if args.system:
+        xe = XE()  # Create the singleton instance
+        xe.initialize(mmdb_path=Path(args.system), context_dir=Path(args.context),
+                      scenario_file=Path(args.scenario), verbose=args.verbose, debug=args.debug)
+
+    print("\nNo problemo")  # Comment this line out before release
+    logger.info("No problemo")  # We didn't die on an exception, basically
+    if args.verbose or args.debug:
+        print("\nNo problemo")
+
+
+if __name__ == "__main__":
+    main()