math-spec-mapping 0.3.14__tar.gz → 0.3.15__tar.gz

{math_spec_mapping-0.3.14/src/math_spec_mapping.egg-info → math_spec_mapping-0.3.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: math-spec-mapping
-Version: 0.3.14
+Version: 0.3.15
 Summary: A library for easy mapping of mathematical specifications.
 Author-email: Sean McOwen <Sean@Block.Science>
 Classifier: Programming Language :: Python :: 3

{math_spec_mapping-0.3.14 → math_spec_mapping-0.3.15}/pyproject.toml

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

{math_spec_mapping-0.3.14 → math_spec_mapping-0.3.15}/src/math_spec_mapping/Classes/Block.py

@@ -11,6 +11,10 @@ class Block:
         self.codomain = data["codomain"]
         self.parameters_used = data["parameters_used"]
         self.metadata = data["metadata"]
+        if "metrics_used" in data:
+            self.metrics_used = data["metrics_used"]
+        else:
+            self.metrics_used = []
         if "label" in data:
             self.label = data["label"]
         else:
@@ -163,6 +167,10 @@ class ParallelBlock(Block):
         self.components = data["components"]
         self.description = data["description"]
         self.constraints = data["constraints"]
+        if "metrics_used" in data:
+            self.metrics_used = data["metrics_used"]
+        else:
+            self.metrics_used = []
         self.mermaid_show_name = data["mermaid_show_name"]
         self.domain = tuple(
             [
@@ -316,6 +324,10 @@ class StackBlock(Block):
         self.mermaid_show_name = data["mermaid_show_name"]
         self.optional_indices = data["optional_indices"]
         self.loop = data["loop"]
+        if "metrics_used" in data:
+            self.metrics_used = data["metrics_used"]
+        else:
+            self.metrics_used = []
         self._check_domain_mapping()
         self.domain = self.components[0].domain
         self.codomain = self.components[-1].codomain
@@ -470,6 +482,10 @@ class SplitBlock(Block):
         self.description = data["description"]
         self.constraints = data["constraints"]
         self.mermaid_show_name = data["mermaid_show_name"]
+        if "metrics_used" in data:
+            self.metrics_used = data["metrics_used"]
+        else:
+            self.metrics_used = []
         self.domain = tuple(
             [
                 i

{math_spec_mapping-0.3.14 → math_spec_mapping-0.3.15}/src/math_spec_mapping/Classes/MathSpec.py

@@ -32,7 +32,9 @@ class MathSpec:
         ]
         self.stateful_metrics = ms_dict["Stateful Metrics"]
         self.wiring = ms_dict["Wiring"]
-        self.blocks = ms_dict["Blocks"]
+        # self.blocks = ms_dict["Blocks"]
+        self._load_blocks()
+        self._load_components()
         self.types = ms_dict["Types"]
         self.metrics = ms_dict["Metrics"]
         self.displays = ms_dict["Displays"]
@@ -206,6 +208,21 @@ class MathSpec:
 
         return out
 
+    def _load_blocks(self):
+        self.blocks = {}
+        self.blocks.update(self.control_actions)
+        self.blocks.update(self.boundary_actions)
+        self.blocks.update(self.policies)
+        self.blocks.update(self.mechanisms)
+        self.blocks.update(self.wiring)
+
+    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)
+
     def crawl_action_chains(self, action_keys: List[str]) -> dict:
         """Crawl the graph of the actions to find all policies, entities, edges, etc.
 

{math_spec_mapping-0.3.14 → math_spec_mapping-0.3.15}/src/math_spec_mapping/Classes/Policy.py

@@ -15,4 +15,3 @@ class Policy(Block):
         super().__init__(data)
         self.policy_options: List[PolicyOption] = data["policy_options"]
         self.block_type = "Policy"
-        self.metrics_used = data["metrics_used"]

{math_spec_mapping-0.3.14 → math_spec_mapping-0.3.15}/src/math_spec_mapping/Classes/Space.py

@@ -7,6 +7,8 @@ class Space:
         self.schema = data["schema"]
         self.metadata = data["metadata"]
         self.name_variable = self.name.replace(" ", "").replace("-", "_")
+        self.domain_blocks = []
+        self.codomain_blocks = []
 
     def __repr__(self):
         return self.name

{math_spec_mapping-0.3.14 → math_spec_mapping-0.3.15}/src/math_spec_mapping/Load/boundary_actions.py

@@ -79,3 +79,9 @@ def load_boundary_actions(ms: Dict, json: Dict) -> None:
         ms["Boundary Actions"][key] = convert_boundary_action(ba, ms)
         for entity in ms["Boundary Actions"][key].called_by:
             entity.add_boundary_action(ms["Boundary Actions"][key])
+
+        for space in ms["Boundary Actions"][key].domain:
+            space.domain_blocks.append(ms["Boundary Actions"][key])
+
+        for space in ms["Boundary Actions"][key].codomain:
+            space.codomain_blocks.append(ms["Boundary Actions"][key])

{math_spec_mapping-0.3.14 → math_spec_mapping-0.3.15}/src/math_spec_mapping/Load/control_actions.py

@@ -66,3 +66,10 @@ def load_control_actions(ms: Dict, json: Dict) -> None:
     ms["Control Actions"] = {}
     for ca in json["Control Actions"]:
         ms["Control Actions"][ca["name"]] = convert_control_action(ca, ms)
+
+        key = ca["name"]
+        for space in ms["Control Actions"][key].domain:
+            space.domain_blocks.append(ms["Control Actions"][key])
+
+        for space in ms["Control Actions"][key].codomain:
+            space.codomain_blocks.append(ms["Control Actions"][key])

{math_spec_mapping-0.3.14 → math_spec_mapping-0.3.15}/src/math_spec_mapping/Load/load.py

@@ -78,4 +78,7 @@ def load_from_json(json: Dict) -> MathSpec:
     check_json_keys(ms, "Math Spec")
 
     ms = MathSpec(ms, json)
+    for space in ms.spaces.values():
+        space.domain_blocks = list(set(space.domain_blocks))
+        space.codomain_blocks = list(set(space.codomain_blocks))
     return ms

{math_spec_mapping-0.3.14 → math_spec_mapping-0.3.15}/src/math_spec_mapping/Load/mechanism.py

@@ -68,4 +68,11 @@ def load_mechanisms(ms: Dict, json: Dict) -> None:
     for m in json["Mechanisms"]:
         ms["Mechanisms"][m["name"]], new_channels = convert_mechanism(m, ms)
         state_update_transmission_channels.extend(new_channels)
+
+        key = m["name"]
+        for space in ms["Mechanisms"][key].domain:
+            space.domain_blocks.append(ms["Mechanisms"][key])
+
+        for space in ms["Mechanisms"][key].codomain:
+            space.codomain_blocks.append(ms["Mechanisms"][key])
     return state_update_transmission_channels

{math_spec_mapping-0.3.14 → math_spec_mapping-0.3.15}/src/math_spec_mapping/Load/metrics.py

@@ -105,14 +105,15 @@ def load_metrics(ms: Dict, json: Dict, stateful_metrics_map) -> None:
         assert len(metrics) == 0, "There are circular references"
 
     # Load the metrics into the policies
-    for key in ms["Policies"]:
-        policy = ms["Policies"][key]
-        hold = policy.metrics_used[:]
-        policy.metrics_used = []
+    for key in ms["Blocks"]:
+        block = ms["Blocks"][key]
+        hold = block.metrics_used[:]
+        block.metrics_used = []
         for x in hold:
             assert (
                 x in ms["Metrics"] or x in stateful_metrics_map
             ), "{} not a valid metric or stateful metric".format(x)
-            policy.metrics_used.append(
+            block.metrics_used.append(
                 ms["Metrics"][x] if x in ms["Metrics"] else stateful_metrics_map[x]
             )
+        block.metrics_used = sorted(block.metrics_used, key=lambda x: x.name)

{math_spec_mapping-0.3.14 → math_spec_mapping-0.3.15}/src/math_spec_mapping/Load/policy.py

@@ -92,3 +92,10 @@ def load_policies(ms: Dict, json: Dict) -> None:
     ms["Policies"] = {}
     for policy in json["Policies"]:
         ms["Policies"][policy["name"]] = convert_policy(policy, ms)
+
+        key = policy["name"]
+        for space in ms["Policies"][key].domain:
+            space.domain_blocks.append(ms["Policies"][key])
+
+        for space in ms["Policies"][key].codomain:
+            space.codomain_blocks.append(ms["Policies"][key])

{math_spec_mapping-0.3.14 → math_spec_mapping-0.3.15}/src/math_spec_mapping/Load/wiring.py

@@ -24,6 +24,11 @@ def load_single_wiring(data, ms):
     # Map components
     data["components"] = [ms["Blocks"][x] for x in data["components"]]
 
+    data["metrics_used"] = []
+    for x in data["components"]:
+        data["metrics_used"].extend(x.metrics_used)
+    data["metrics_used"] = list(set(data["metrics_used"]))
+
     # Map to the correct block
     if block_type == "Stack":
         block = StackBlock(data)

{math_spec_mapping-0.3.14 → math_spec_mapping-0.3.15}/src/math_spec_mapping/Reports/markdown.py

@@ -157,6 +157,18 @@ def write_boundary_action_markdown_report(ms, path, boundary_action, add_metadat
         out += "\n"
     out += "\n"
 
+    out += "## Metrics Used\n"
+    for i, x in enumerate(boundary_action.metrics_used):
+        out += "{}. [[{}]]".format(i + 1, x.name)
+        out += "\n"
+    out += "\n"
+
+    out += "## Parameters Used\n"
+    for i, x in enumerate(sorted(boundary_action.parameters_used, key=lambda x: x)):
+        out += "{}. [[{}]]".format(i + 1, x)
+        out += "\n"
+    out += "\n"
+
     if boundary_action.boundary_action_options:
         out += "## Boundary Action Options:\n"
         for i, x in enumerate(boundary_action.boundary_action_options):
@@ -288,6 +300,18 @@ def write_mechanism_markdown_report(ms, path, mechanism, add_metadata=True):
         out += "{}. {}".format(i + 1, x)
         out += "\n"
 
+    out += "## Metrics Used\n"
+    for i, x in enumerate(mechanism.metrics_used):
+        out += "{}. [[{}]]".format(i + 1, x.name)
+        out += "\n"
+    out += "\n"
+
+    out += "## Parameters Used\n"
+    for i, x in enumerate(sorted(mechanism.parameters_used, key=lambda x: x)):
+        out += "{}. [[{}]]".format(i + 1, x)
+        out += "\n"
+    out += "\n"
+
     out += "## Logic\n"
     out += mechanism.logic
 
@@ -329,6 +353,20 @@ def write_space_markdown_report(ms, path, space, add_metadata=True):
     )
     d = "{" + d + "}"
     out += d
+    out += "\n\n"
+
+    out += "## Blocks with Space in Domain"
+    out += "\n"
+    for i, x in enumerate(space.domain_blocks):
+        out += "{}. [[{}]]".format(i + 1, x.name)
+        out += "\n"
+    out += "\n"
+
+    out += "## Blocks with Space in Codomain"
+    out += "\n"
+    for i, x in enumerate(space.codomain_blocks):
+        out += "{}. [[{}]]".format(i + 1, x.name)
+        out += "\n"
     out += "\n"
 
     with open("{}/Spaces/{}.md".format(path, space.name), "w") as f:
@@ -374,6 +412,12 @@ def write_control_action_markdown_report(ms, path, control_action, add_metadata=
         out += "\n"
     out += "\n"
 
+    out += "## Metrics Used\n"
+    for i, x in enumerate(control_action.metrics_used):
+        out += "{}. [[{}]]".format(i + 1, x.name)
+        out += "\n"
+    out += "\n"
+
     out += "## Parameters Used\n"
     for i, x in enumerate(sorted(control_action.parameters_used, key=lambda x: x)):
         out += "{}. [[{}]]".format(i + 1, x)
@@ -463,6 +507,12 @@ def write_wiring_markdown_report(ms, path, wiring, add_metadata=True):
         out += "\n"
     out += "\n"
 
+    out += "## Metrics Used\n"
+    for i, x in enumerate(wiring.metrics_used):
+        out += "{}. [[{}]]".format(i + 1, x.name)
+        out += "\n"
+    out += "\n"
+
     out += "## Parameters Used\n"
     for i, x in enumerate(sorted(wiring.parameters_used, key=lambda x: x)):
         out += "{}. [[{}]]".format(i + 1, x)

{math_spec_mapping-0.3.14 → math_spec_mapping-0.3.15/src/math_spec_mapping.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: math-spec-mapping
-Version: 0.3.14
+Version: 0.3.15
 Summary: A library for easy mapping of mathematical specifications.
 Author-email: Sean McOwen <Sean@Block.Science>
 Classifier: Programming Language :: Python :: 3