math-spec-mapping 0.3.20__tar.gz → 0.4.0__tar.gz

{math_spec_mapping-0.3.20/src/math_spec_mapping.egg-info → math_spec_mapping-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: math-spec-mapping
-Version: 0.3.20
+Version: 0.4.0
 Summary: A library for easy mapping of mathematical specifications.
 Author-email: Sean McOwen <Sean@Block.Science>
 Classifier: Programming Language :: Python :: 3
@@ -13,7 +13,9 @@ Requires-Dist: graphviz>=0.20.1
 Requires-Dist: ipython>=7.7.0
 Requires-Dist: pandas>=1.4
 
-# MSML
+# Mathematical Specification Mapping Library (MSML)
+
+For documentation and getting started with MSML, please refer to the site for MSML [here](https://blockscience.github.io/MSML/).
 
 ## What is the Mathematical Specification Mapping Library (MSML)?
 
@@ -21,7 +23,7 @@ MSML is a library for standardizing the creation of mathematical specifications
 
 It uses block diagram wirings and spaces to represent the actions in complex systems in line with current BlockScience research on Generalized Dynamical Systems. It also adds some enhancements to the primitive blocks to represent richer sets of behaviors.
 
-One good example is the [wiring report](https://github.com/SeanMcOwen/Root-Finding-Simulation/blob/main/MSML/reports/Simulation%20Block.md) for the Root Finding Simulation canonical example.
+One good example is the [wiring report](https://github.com/BlockScience/Predator-Prey-MSML/blob/main/reports/obsidian/Wiring/Hunt%20Prey%20Wiring.md) for hunt prey wiring in the predator prey example (although it is best viewed in Obsidian where all the linking will work).
 
 ## Installing the library
 
@@ -31,6 +33,12 @@ To install the library, simply pip install by running "pip install math_spec_map
 
 Writing mathematical specifications can be a difficult process, especially when variable names are changed or new mechanisms are introduced. MSML seeks to streamline the process with automations as well as enhance the abilities of static math specs to deliver deeper insights. Because it is automated, one can write specifications at different levels of details or for different purposes.
 
+### Stakeholder Communications
+
+- In organizations, senior people / non-developers don't always have as intimate a view of the underlying code as the primary developers in a system because of time constraints and not working as directly with the code as the primary developers
+- Often this means that there is a reliance on asking the primary developers for clarifications and relying on "front-end" kinds of stuff such as visualizations or outputs of the model as opposed to combing through the underlying code
+- MSML seeks to help bridge this gap by allowing for the Obsidian markdown vault that can showcase every component and its dependencies for easier consumption.... this reduces the barriers to entry on understanding the back-end/underlying model
+- Also through things such as code linking, MSML allows for those with code fluency to jump into underlying code if they need to without even opening up the actual project repository
 
 ## What are some of the solutions offered?
 
@@ -79,34 +87,6 @@ Thanks to some of the more advanced features, MSML can be used as an aid for deb
 
 The ability to fork the repository of an MSML spec as well as the ability to use it for A/B testing with the policy options makes it well suited for iterating on model evolution. 
 
-## Technical Details
-
-The documentation on the technical details of using the MSML can be found [here](https://github.com/BlockScience/MSML/tree/main/docs)
-
-## Canonical Examples
-
-[Dummy/Starter Repository](https://github.com/BlockScience/MSML/tree/main/examples/StarterRepo)
-[Root Finding Simulation](https://github.com/SeanMcOwen/Root-Finding-Simulation)
-
-### Comparison of Canonical Example Features
-
-| Feature | Dummy | Root Finding |
-| --- | --- | --- |
-| Action Transmission Channels | X | X |
-| Stack Block | X | X |
-| Parallel Block |  | X |
-| Split Block |  |  |
-| Boundary Actions | X |  |
-| Control Actions | X | X |
-| Entities | X |  |
-| Mechanisms | X | X |
-| Parameters | X | X |
-| Policies | X | X |
-| Spaces | X | X |
-| State | X | X |
-| Stateful Metrics |  |  |
-| State Update Transmission Channels | X | X |
-| Reports | X | X |
 
 ##  Other Related Repositories
 

{math_spec_mapping-0.3.20 → math_spec_mapping-0.4.0}/README.md

@@ -1,4 +1,6 @@
-# MSML
+# Mathematical Specification Mapping Library (MSML)
+
+For documentation and getting started with MSML, please refer to the site for MSML [here](https://blockscience.github.io/MSML/).
 
 ## What is the Mathematical Specification Mapping Library (MSML)?
 
@@ -6,7 +8,7 @@ MSML is a library for standardizing the creation of mathematical specifications
 
 It uses block diagram wirings and spaces to represent the actions in complex systems in line with current BlockScience research on Generalized Dynamical Systems. It also adds some enhancements to the primitive blocks to represent richer sets of behaviors.
 
-One good example is the [wiring report](https://github.com/SeanMcOwen/Root-Finding-Simulation/blob/main/MSML/reports/Simulation%20Block.md) for the Root Finding Simulation canonical example.
+One good example is the [wiring report](https://github.com/BlockScience/Predator-Prey-MSML/blob/main/reports/obsidian/Wiring/Hunt%20Prey%20Wiring.md) for hunt prey wiring in the predator prey example (although it is best viewed in Obsidian where all the linking will work).
 
 ## Installing the library
 
@@ -16,6 +18,12 @@ To install the library, simply pip install by running "pip install math_spec_map
 
 Writing mathematical specifications can be a difficult process, especially when variable names are changed or new mechanisms are introduced. MSML seeks to streamline the process with automations as well as enhance the abilities of static math specs to deliver deeper insights. Because it is automated, one can write specifications at different levels of details or for different purposes.
 
+### Stakeholder Communications
+
+- In organizations, senior people / non-developers don't always have as intimate a view of the underlying code as the primary developers in a system because of time constraints and not working as directly with the code as the primary developers
+- Often this means that there is a reliance on asking the primary developers for clarifications and relying on "front-end" kinds of stuff such as visualizations or outputs of the model as opposed to combing through the underlying code
+- MSML seeks to help bridge this gap by allowing for the Obsidian markdown vault that can showcase every component and its dependencies for easier consumption.... this reduces the barriers to entry on understanding the back-end/underlying model
+- Also through things such as code linking, MSML allows for those with code fluency to jump into underlying code if they need to without even opening up the actual project repository
 
 ## What are some of the solutions offered?
 
@@ -64,34 +72,6 @@ Thanks to some of the more advanced features, MSML can be used as an aid for deb
 
 The ability to fork the repository of an MSML spec as well as the ability to use it for A/B testing with the policy options makes it well suited for iterating on model evolution. 
 
-## Technical Details
-
-The documentation on the technical details of using the MSML can be found [here](https://github.com/BlockScience/MSML/tree/main/docs)
-
-## Canonical Examples
-
-[Dummy/Starter Repository](https://github.com/BlockScience/MSML/tree/main/examples/StarterRepo)
-[Root Finding Simulation](https://github.com/SeanMcOwen/Root-Finding-Simulation)
-
-### Comparison of Canonical Example Features
-
-| Feature | Dummy | Root Finding |
-| --- | --- | --- |
-| Action Transmission Channels | X | X |
-| Stack Block | X | X |
-| Parallel Block |  | X |
-| Split Block |  |  |
-| Boundary Actions | X |  |
-| Control Actions | X | X |
-| Entities | X |  |
-| Mechanisms | X | X |
-| Parameters | X | X |
-| Policies | X | X |
-| Spaces | X | X |
-| State | X | X |
-| Stateful Metrics |  |  |
-| State Update Transmission Channels | X | X |
-| Reports | X | X |
 
 ##  Other Related Repositories
 

{math_spec_mapping-0.3.20 → math_spec_mapping-0.4.0}/pyproject.toml

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

{math_spec_mapping-0.3.20 → math_spec_mapping-0.4.0}/src/math_spec_mapping/Classes/Block.py

@@ -75,7 +75,7 @@ class Block:
         if self.block_type == "Mechanism":
             for u in sorted(self.updates, key=lambda x: x[0].name + "-" + x[1].name):
                 out += "\n"
-                out += "X{} --> {}".format(
+                out += 'X{} --"State Update"--> {}'.format(
                     i,
                     (u[0].name + "-" + u[1].name).replace(" ", "-"),
                 )
@@ -248,7 +248,7 @@ class ParallelBlock(Block):
                 self.all_updates, key=lambda x: x[0].name + "-" + x[1].name
             ):
                 out += "\n"
-                out += "X{} --> {}".format(
+                out += 'X{} --"State Update"--> {}'.format(
                     i,
                     (u[0].name + "-" + u[1].name).replace(" ", "-"),
                 )
@@ -445,7 +445,7 @@ class StackBlock(Block):
                 self.all_updates, key=lambda x: x[0].name + "-" + x[1].name
             ):
                 out += "\n"
-                out += "X{} --> {}".format(
+                out += 'X{} --"State Update"--> {}'.format(
                     i,
                     (u[0].name + "-" + u[1].name).replace(" ", "-"),
                 )

{math_spec_mapping-0.3.20 → math_spec_mapping-0.4.0}/src/math_spec_mapping/Classes/MathSpec.py

@@ -727,11 +727,13 @@ class MathSpec:
         state_preperation_functions=None,
         parameter_preperation_functions=None,
         metrics_functions=None,
+        append_param_change_columns=False,
     ):
         state_l = []
         params_l = []
         df_l = []
         metrics_l = []
+        param_mods = set()
         for experiment in experiments:
             for i in range(experiment["Monte Carlo Runs"]):
                 state, params, msi, df, metrics = self.run_experiment(
@@ -743,6 +745,11 @@ class MathSpec:
                     parameter_preperation_functions=parameter_preperation_functions,
                     metrics_functions=metrics_functions,
                 )
+                if append_param_change_columns:
+                    if experiment["Param Modifications"]:
+                        for key in experiment["Param Modifications"]:
+                            df[key] = experiment["Param Modifications"][key]
+                            param_mods.add(key)
                 df["Monte Carlo Run"] = i + 1
                 df["Experiment"] = experiment["Name"]
                 metrics.loc["Monte Carlo Run"] = i + 1
@@ -753,6 +760,9 @@ class MathSpec:
                 df_l.append(df)
                 metrics_l.append(metrics)
         df = pd.concat(df_l)
+        if append_param_change_columns:
+            for key in param_mods:
+                df[key] = df[key].fillna(params_base[key])
         metrics = pd.concat(metrics_l, axis=1).T
         return df, metrics, state_l, params_l
 
@@ -1022,6 +1032,12 @@ class MathSpecImplementation:
                     ), "No functional parameterization for {}. To fix this error, add {} to the parameters passed to ms.build_implementation. Option can be: {}".format(
                         ca.name, "FP " + ca.name, [x.name for x in opts]
                     )
+                    assert (
+                        self.params["FP {}".format(ca.name)]
+                        in self.ms.functional_parameters["FP {}".format(ca.name)]
+                    ), "{} is not a valid functional parameterization for {}".format(
+                        self.params["FP {}".format(ca.name)], ca.name
+                    )
                     opt = self.ms.functional_parameters["FP {}".format(ca.name)][
                         self.params["FP {}".format(ca.name)]
                     ]
@@ -1061,6 +1077,13 @@ class MathSpecImplementation:
                         ba.name, "FP " + ba.name, [x.name for x in opts]
                     )
 
+                    assert (
+                        self.params["FP {}".format(ba.name)]
+                        in self.ms.functional_parameters["FP {}".format(ba.name)]
+                    ), "{} is not a valid functional parameterization for {}".format(
+                        self.params["FP {}".format(ba.name)], ba.name
+                    )
+
                     opt = self.ms.functional_parameters["FP {}".format(ba.name)][
                         self.params["FP {}".format(ba.name)]
                     ]
@@ -1165,6 +1188,12 @@ class MathSpecImplementation:
                     ), "No functional parameterization for {}. To fix this error, add {} to the parameters passed to ms.build_implementation. Option can be: {}".format(
                         p.name, "FP " + p.name, [x.name for x in opts]
                     )
+                    assert (
+                        self.params["FP {}".format(p.name)]
+                        in self.ms.functional_parameters["FP {}".format(p.name)]
+                    ), "{} is not a valid functional parameterization for {}".format(
+                        self.params["FP {}".format(p.name)], p.name
+                    )
                     opt = self.ms.functional_parameters["FP {}".format(p.name)][
                         self.params["FP {}".format(p.name)]
                     ]

{math_spec_mapping-0.3.20 → math_spec_mapping-0.4.0}/src/math_spec_mapping/Convenience/github.py

@@ -92,6 +92,15 @@ def create_milestone_label_matrix(df, exclude_milestones=None):
     labels = list(df.columns[4:])
     labels = sorted([x for x in labels if x not in priority_labels])
     milestones = sorted(list(df[~pd.isnull(df["Milestone"])]["Milestone"].unique()))
+    try:
+        milestones = sorted(
+            milestones,
+            key=lambda x: int(x.split(".")[0][1:]) * 10000
+            + int(x.split(".")[1]) * 100
+            + int(x.split(".")[2]),
+        )
+    except:
+        pass
 
     table = []
     for label in labels:

{math_spec_mapping-0.3.20 → math_spec_mapping-0.4.0/src/math_spec_mapping.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: math-spec-mapping
-Version: 0.3.20
+Version: 0.4.0
 Summary: A library for easy mapping of mathematical specifications.
 Author-email: Sean McOwen <Sean@Block.Science>
 Classifier: Programming Language :: Python :: 3
@@ -13,7 +13,9 @@ Requires-Dist: graphviz>=0.20.1
 Requires-Dist: ipython>=7.7.0
 Requires-Dist: pandas>=1.4
 
-# MSML
+# Mathematical Specification Mapping Library (MSML)
+
+For documentation and getting started with MSML, please refer to the site for MSML [here](https://blockscience.github.io/MSML/).
 
 ## What is the Mathematical Specification Mapping Library (MSML)?
 
@@ -21,7 +23,7 @@ MSML is a library for standardizing the creation of mathematical specifications
 
 It uses block diagram wirings and spaces to represent the actions in complex systems in line with current BlockScience research on Generalized Dynamical Systems. It also adds some enhancements to the primitive blocks to represent richer sets of behaviors.
 
-One good example is the [wiring report](https://github.com/SeanMcOwen/Root-Finding-Simulation/blob/main/MSML/reports/Simulation%20Block.md) for the Root Finding Simulation canonical example.
+One good example is the [wiring report](https://github.com/BlockScience/Predator-Prey-MSML/blob/main/reports/obsidian/Wiring/Hunt%20Prey%20Wiring.md) for hunt prey wiring in the predator prey example (although it is best viewed in Obsidian where all the linking will work).
 
 ## Installing the library
 
@@ -31,6 +33,12 @@ To install the library, simply pip install by running "pip install math_spec_map
 
 Writing mathematical specifications can be a difficult process, especially when variable names are changed or new mechanisms are introduced. MSML seeks to streamline the process with automations as well as enhance the abilities of static math specs to deliver deeper insights. Because it is automated, one can write specifications at different levels of details or for different purposes.
 
+### Stakeholder Communications
+
+- In organizations, senior people / non-developers don't always have as intimate a view of the underlying code as the primary developers in a system because of time constraints and not working as directly with the code as the primary developers
+- Often this means that there is a reliance on asking the primary developers for clarifications and relying on "front-end" kinds of stuff such as visualizations or outputs of the model as opposed to combing through the underlying code
+- MSML seeks to help bridge this gap by allowing for the Obsidian markdown vault that can showcase every component and its dependencies for easier consumption.... this reduces the barriers to entry on understanding the back-end/underlying model
+- Also through things such as code linking, MSML allows for those with code fluency to jump into underlying code if they need to without even opening up the actual project repository
 
 ## What are some of the solutions offered?
 
@@ -79,34 +87,6 @@ Thanks to some of the more advanced features, MSML can be used as an aid for deb
 
 The ability to fork the repository of an MSML spec as well as the ability to use it for A/B testing with the policy options makes it well suited for iterating on model evolution. 
 
-## Technical Details
-
-The documentation on the technical details of using the MSML can be found [here](https://github.com/BlockScience/MSML/tree/main/docs)
-
-## Canonical Examples
-
-[Dummy/Starter Repository](https://github.com/BlockScience/MSML/tree/main/examples/StarterRepo)
-[Root Finding Simulation](https://github.com/SeanMcOwen/Root-Finding-Simulation)
-
-### Comparison of Canonical Example Features
-
-| Feature | Dummy | Root Finding |
-| --- | --- | --- |
-| Action Transmission Channels | X | X |
-| Stack Block | X | X |
-| Parallel Block |  | X |
-| Split Block |  |  |
-| Boundary Actions | X |  |
-| Control Actions | X | X |
-| Entities | X |  |
-| Mechanisms | X | X |
-| Parameters | X | X |
-| Policies | X | X |
-| Spaces | X | X |
-| State | X | X |
-| Stateful Metrics |  |  |
-| State Update Transmission Channels | X | X |
-| Reports | X | X |
 
 ##  Other Related Repositories