math-spec-mapping 0.3.6__tar.gz → 0.3.8__tar.gz

{math_spec_mapping-0.3.6/src/math_spec_mapping.egg-info → math_spec_mapping-0.3.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: math-spec-mapping
-Version: 0.3.6
+Version: 0.3.8
 Summary: A library for easy mapping of mathematical specifications.
 Author-email: Sean McOwen <Sean@Block.Science>
 Classifier: Programming Language :: Python :: 3
@@ -45,8 +45,9 @@ Writing mathematical specifications can be a difficult process, especially when
 ```mermaid
 graph TD
 A[JSON Object \n\n Each spec has a repo for tracking changes \n Must conform to the json specification \n Defines all aspects of the spec including blocks, spaces and actions] -->B[MSML Object \n\n JSON file is parsed, with validations and mappings along the way \n Can show different views on the fly]
-    B --> C[Report Outputs \n\n Automatically build reports for the full spec or subviews \n Example: all blocks with an effect on variable XYZ]
-
+    B --> C[Report Outputs & Obsidian Directory \n\n Automatically build reports for the full spec or subviews \n Example: all blocks with an effect on variable XYZ\n Also builds an entire Obsidian directory of all components as linked notes]
+D[Python Function Implementations \n\n Optional enhancement to actually execute code\n Done for each referenced policy option, mechanism, etc. \n Just needs a function definition for each] --> B 
+B --> E[Python Wirings & Simulations \n\n MSML can be used to run blocks \n Wirings automatically work to pass between domain/codomains \n Entire simulations can be built up as composed wirings]
 ```
 
 ## MSML in the Engineering Lifecycle

{math_spec_mapping-0.3.6 → math_spec_mapping-0.3.8}/README.md

@@ -30,8 +30,9 @@ Writing mathematical specifications can be a difficult process, especially when
 ```mermaid
 graph TD
 A[JSON Object \n\n Each spec has a repo for tracking changes \n Must conform to the json specification \n Defines all aspects of the spec including blocks, spaces and actions] -->B[MSML Object \n\n JSON file is parsed, with validations and mappings along the way \n Can show different views on the fly]
-    B --> C[Report Outputs \n\n Automatically build reports for the full spec or subviews \n Example: all blocks with an effect on variable XYZ]
-
+    B --> C[Report Outputs & Obsidian Directory \n\n Automatically build reports for the full spec or subviews \n Example: all blocks with an effect on variable XYZ\n Also builds an entire Obsidian directory of all components as linked notes]
+D[Python Function Implementations \n\n Optional enhancement to actually execute code\n Done for each referenced policy option, mechanism, etc. \n Just needs a function definition for each] --> B 
+B --> E[Python Wirings & Simulations \n\n MSML can be used to run blocks \n Wirings automatically work to pass between domain/codomains \n Entire simulations can be built up as composed wirings]
 ```
 
 ## MSML in the Engineering Lifecycle

{math_spec_mapping-0.3.6 → math_spec_mapping-0.3.8}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools>=61.0"]
 build-backend = "setuptools.build_meta"
 [project]
 name = "math-spec-mapping"
-version = "0.3.6"
+version = "0.3.8"
 authors = [
   { name="Sean McOwen", email="Sean@Block.Science" },
 ]

{math_spec_mapping-0.3.6 → math_spec_mapping-0.3.8}/src/math_spec_mapping/Classes/MathSpec.py

@@ -7,6 +7,7 @@ from .BoundaryAction import BoundaryAction
 import os
 from copy import deepcopy
 import shutil
+import pandas as pd
 
 
 class MathSpec:
@@ -469,6 +470,83 @@ class MathSpec:
         with open(path, "w") as f:
             f.write(out)
 
+    def run_experiment(
+        self,
+        experiment,
+        params_base,
+        state_base,
+        post_processing_function,
+        state_preperation_functions=None,
+        parameter_preperation_functions=None,
+        metrics_functions=None,
+    ):
+        if experiment["Param Modifications"]:
+            params_base = deepcopy(params_base)
+            for key in experiment["Param Modifications"]:
+                params_base[key] = experiment["Param Modifications"][key]
+        if experiment["State Modifications"]:
+            state_base = deepcopy(state_base)
+            for key in experiment["State Modifications"]:
+                state_base[key] = experiment["State Modifications"][key]
+        msi = self.build_implementation(params_base)
+        state, params = msi.prepare_state_and_params(
+            state_base,
+            params_base,
+            state_preperation_functions=state_preperation_functions,
+            parameter_preperation_functions=parameter_preperation_functions,
+        )
+
+        state = msi.execute_blocks(state, params, experiment["Blocks"])
+        df = post_processing_function(state, params)
+
+        if metrics_functions:
+            metrics = {}
+            for metrics_function in metrics_functions:
+                metrics_function(metrics, state, params, df)
+            metrics = pd.Series(metrics)
+        else:
+            metrics = None
+
+        return state, params, msi, df, metrics
+
+    def run_experiments(
+        self,
+        experiments,
+        params_base,
+        state_base,
+        post_processing_function,
+        state_preperation_functions=None,
+        parameter_preperation_functions=None,
+        metrics_functions=None,
+    ):
+        state_l = []
+        params_l = []
+        df_l = []
+        metrics_l = []
+        for experiment in experiments:
+            for i in range(experiment["Monte Carlo Runs"]):
+                state, params, msi, df, metrics = self.run_experiment(
+                    experiment,
+                    params_base,
+                    state_base,
+                    post_processing_function,
+                    state_preperation_functions=state_preperation_functions,
+                    parameter_preperation_functions=parameter_preperation_functions,
+                    metrics_functions=metrics_functions,
+                )
+                df["Monte Carlo Run"] = i + 1
+                df["Experiment"] = experiment["Name"]
+                metrics.loc["Monte Carlo Run"] = i + 1
+                metrics.loc["Experiment"] = experiment["Name"]
+                metrics.name = "{}-{}".format(experiment["Name"], i + 1)
+                state_l.append(state)
+                params_l.append(params)
+                df_l.append(df)
+                metrics_l.append(metrics)
+        df = pd.concat(df_l)
+        metrics = pd.concat(metrics_l, axis=1).T
+        return df, metrics, state_l, params_l
+
     def metaprogramming_python_states(
         self, model_directory, overwrite=False, default_values=None
     ):
@@ -698,6 +776,7 @@ class MathSpecImplementation:
         self.mechanisms = self.load_mechanisms()
         self.stateful_metrics = self.load_stateful_metrics()
         self.load_wiring()
+        self.load_components()
 
     def load_control_actions(self):
         control_actions = {}
@@ -776,6 +855,9 @@ class MathSpecImplementation:
 
     def load_single_wiring(self, wiring):
         hold = wiring
+        domain_sizes = {}
+        for x in wiring.components:
+            domain_sizes[x.name] = len(x.domain)
         components = [x.name for x in wiring.components]
         if wiring.block_type == "Stack Block":
 
@@ -795,10 +877,17 @@ class MathSpecImplementation:
                 spaces_mapping[x].append(i)
 
             def wiring(state, params, spaces):
+                spaces_mapping_temp = deepcopy(spaces_mapping)
                 codomain = []
                 for component in components:
-                    if component in spaces_mapping:
-                        spaces_i = [spaces[i] for i in spaces_mapping[component]]
+                    if component in spaces_mapping_temp:
+                        spaces_i = [spaces[i] for i in spaces_mapping_temp[component]][
+                            : domain_sizes[component]
+                        ]
+                        # Fix for repeated block names
+                        spaces_mapping_temp[component] = spaces_mapping_temp[component][
+                            domain_sizes[component] :
+                        ]
                     else:
                         assert component in [
                             x.name for x in hold.domain_blocks_empty
@@ -926,9 +1015,40 @@ class MathSpecImplementation:
             len(shouldnt_be_in_params) == 0
         ), "The following parameters are extra: {}".format(shouldnt_be_in_params)
 
-    def prepare_state_and_params(self, state, params):
+    def prepare_state_and_params(
+        self,
+        state,
+        params,
+        state_preperation_functions=None,
+        parameter_preperation_functions=None,
+    ):
         self.validate_state_and_params(state, params)
         state = deepcopy(state)
         params = deepcopy(params)
         state["Stateful Metrics"] = self.stateful_metrics
+        if state_preperation_functions:
+            for f in state_preperation_functions:
+                state = f(state)
+                assert (
+                    state is not None
+                ), "A state must be returned from the state preperation functions"
+        if parameter_preperation_functions:
+            for f in parameter_preperation_functions:
+                params = f(params)
+                assert (
+                    params is not None
+                ), "A parameter set must be returned from the parameter preperation functions"
         return state, params
+
+    def load_components(self):
+        self.components = {}
+        self.components.update(self.control_actions)
+        self.components.update(self.boundary_actions)
+        self.components.update(self.policies)
+        self.components.update(self.mechanisms)
+        self.components.update(self.wiring)
+
+    def execute_blocks(self, state, params, blocks):
+        for block in blocks:
+            self.components[block](state, params, [])
+        return state

{math_spec_mapping-0.3.6 → math_spec_mapping-0.3.8}/src/math_spec_mapping/Convenience/starter.py

@@ -39,19 +39,27 @@ def remove_dummy_repo_components(path):
             with open(path2 + "/__init__.py", "w") as f:
                 f.write(contents)
 
-    """if "Displays" in directory_folders:
+    if "Displays" in directory_folders:
         path2 = path + "/Displays"
         contents = os.listdir(path2)
-        if "Dummy.py" in contents:
-            os.remove(path2 + "/Dummy.py")
-        if "__init__.py" in contents:
-            with open(path2 + "/__init__.py", "r") as f:
+        if "wiring.py" in contents:
+            with open(path2 + "/wiring.py", "r") as f:
                 contents = f.read()
-                contents = contents.replace("from .Dummy import metrics_x\n", "")
-                contents = contents.replace("metrics.extend(metrics_x)\n", "")
-                contents = contents.replace("metrics.extend(metrics_x)", "")
-            with open(path2 + "/__init__.py", "w") as f:
-                f.write(contents)"""
+
+                contents = contents.replace('"Dummy Boundary Wiring 2",\n', "")
+                contents = contents.replace('"Dummy Boundary Wiring 2",', "")
+                contents = contents.replace('"Dummy Boundary Wiring 2"', "")
+
+                contents = contents.replace('"Dummy Boundary Wiring",\n', "")
+                contents = contents.replace('"Dummy Boundary Wiring",', "")
+                contents = contents.replace('"Dummy Boundary Wiring"', "")
+
+                contents = contents.replace('"Dummy Control Wiring",\n', "")
+                contents = contents.replace('"Dummy Control Wiring",', "")
+                contents = contents.replace('"Dummy Control Wiring"', "")
+
+            with open(path2 + "/wiring.py", "w") as f:
+                f.write(contents)
 
     if "Wiring" in directory_folders:
         path2 = path + "/Wiring"
@@ -104,8 +112,14 @@ def remove_dummy_repo_components(path):
             with open(path2 + "/__init__.py", "r") as f:
                 contents = f.read()
                 contents = contents.replace(
-                    "from .Dummy import dummy_boundary_action\n", ""
+                    "from .Dummy import dummy_boundary_action, dummy_boundary_action2\n",
+                    "",
                 )
+
+                contents = contents.replace("dummy_boundary_action2,\n", "")
+                contents = contents.replace("dummy_boundary_action2,", "")
+                contents = contents.replace("dummy_boundary_action2", "")
+
                 contents = contents.replace("dummy_boundary_action,\n", "")
                 contents = contents.replace("dummy_boundary_action,", "")
                 contents = contents.replace("dummy_boundary_action", "")

{math_spec_mapping-0.3.6 → math_spec_mapping-0.3.8/src/math_spec_mapping.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: math-spec-mapping
-Version: 0.3.6
+Version: 0.3.8
 Summary: A library for easy mapping of mathematical specifications.
 Author-email: Sean McOwen <Sean@Block.Science>
 Classifier: Programming Language :: Python :: 3
@@ -45,8 +45,9 @@ Writing mathematical specifications can be a difficult process, especially when
 ```mermaid
 graph TD
 A[JSON Object \n\n Each spec has a repo for tracking changes \n Must conform to the json specification \n Defines all aspects of the spec including blocks, spaces and actions] -->B[MSML Object \n\n JSON file is parsed, with validations and mappings along the way \n Can show different views on the fly]
-    B --> C[Report Outputs \n\n Automatically build reports for the full spec or subviews \n Example: all blocks with an effect on variable XYZ]
-
+    B --> C[Report Outputs & Obsidian Directory \n\n Automatically build reports for the full spec or subviews \n Example: all blocks with an effect on variable XYZ\n Also builds an entire Obsidian directory of all components as linked notes]
+D[Python Function Implementations \n\n Optional enhancement to actually execute code\n Done for each referenced policy option, mechanism, etc. \n Just needs a function definition for each] --> B 
+B --> E[Python Wirings & Simulations \n\n MSML can be used to run blocks \n Wirings automatically work to pass between domain/codomains \n Entire simulations can be built up as composed wirings]
 ```
 
 ## MSML in the Engineering Lifecycle