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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: math-spec-mapping
-Version: 0.3.14
+Version: 0.3.16
 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.16}/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.16"
 authors = [
   { name="Sean McOwen", email="Sean@Block.Science" },
 ]

{math_spec_mapping-0.3.14 → math_spec_mapping-0.3.16}/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:
@@ -65,7 +69,7 @@ class Block:
 
         self.find_all_spaces_used(data)
 
-    def render_mermaid(self, i):
+    def render_mermaid(self, i, go_deep=True):
         i += 1
         out = 'X{}["{}"]'.format(i, self.name)
         if self.block_type == "Mechanism":
@@ -83,7 +87,7 @@ class Block:
         elif self.block_type in ["Parallel Block", "Stack Block", "Split Block"]:
             updates = self.all_updates
         else:
-            return "\n", {}
+            return "\n", {}, 0
         updates = sorted(updates, key=lambda x: x[0].name + "-" + x[1].name)
 
         out = "\n"
@@ -111,18 +115,30 @@ class Block:
             out += "\n"
         out += "end\n"
         out += "\n"
-        return out, entity_variable_mapping
+        return out, entity_variable_mapping, len(entities)
 
-    def render_mermaid_root(self):
+    def render_mermaid_root(self, go_deep=True):
         out = """```mermaid\ngraph TB\n"""
-        add, entity_variable_mapping = self.render_ending_entities()
+        add, entity_variable_mapping, n_entities = self.render_ending_entities()
         out += add
-        out += self.render_mermaid(0)[0]
+        new, i = self.render_mermaid(0, go_deep=go_deep)
+        out += new
 
         for key in entity_variable_mapping:
             out = out.replace(key, entity_variable_mapping[key])
-        out += "\n```"
+        out += "\n"
+        for x in range(1, i):
+            if (
+                "X{}[Domain]".format(x) not in out
+                and "X{}[Codomain]".format(x) not in out
+                and "subgraph X{}".format(x) not in out
+            ):
+                out += "class X{} internal-link;\n".format(x)
+
+        for x in range(n_entities):
+            out += "class EE{} internal-link;\n".format(x)
 
+        out += "\n```"
         return out
 
     def find_all_spaces_used(self, data):
@@ -163,6 +179,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(
             [
@@ -215,7 +235,19 @@ class ParallelBlock(Block):
         self.metadata = data["metadata"]
         self.find_all_spaces_used(data)
 
-    def render_mermaid(self, i):
+    def render_mermaid(self, i, go_deep=True):
+        if go_deep == "First":
+            go_deep = False
+        elif go_deep == False:
+            i += 1
+            out = 'X{}["{}"]'.format(i, self.name)
+            for u in self.all_updates:
+                out += "\n"
+                out += "X{} --> {}".format(
+                    i,
+                    (u[0].name + "-" + u[1].name).replace(" ", "-"),
+                )
+            return out, i
         multi = None
         if type(i) == list:
             multi = i
@@ -243,7 +275,7 @@ class ParallelBlock(Block):
                 if x.name not in ["Empty Space", "Terminating Space"]
             ]
 
-            component, i = component.render_mermaid(i)
+            component, i = component.render_mermaid(i, go_deep=go_deep)
             out += component
             out += "\n"
             domain_map[i] = domain
@@ -316,6 +348,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
@@ -392,7 +428,19 @@ class StackBlock(Block):
                     )
         return channels
 
-    def render_mermaid(self, i):
+    def render_mermaid(self, i, go_deep=True):
+        if go_deep == "First":
+            go_deep = False
+        elif go_deep == False:
+            i += 1
+            out = 'X{}["{}"]'.format(i, self.name)
+            for u in self.all_updates:
+                out += "\n"
+                out += "X{} --> {}".format(
+                    i,
+                    (u[0].name + "-" + u[1].name).replace(" ", "-"),
+                )
+            return out, i
         multi = None
         if type(i) == list:
             multi = i
@@ -411,7 +459,7 @@ class StackBlock(Block):
                 for x in domain
                 if x.name not in ["Empty Space", "Terminating Space"]
             ]
-            component, i = component.render_mermaid(i)
+            component, i = component.render_mermaid(i, go_deep=go_deep)
             domain_map[i] = domain
             out += component
             out += "\n"
@@ -470,6 +518,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
@@ -519,7 +571,7 @@ class SplitBlock(Block):
         self.metadata = data["metadata"]
         self.find_all_spaces_used(data)
 
-    def render_mermaid(self, i):
+    def render_mermaid(self, i, go_deep=True):
         multi = None
         if type(i) == list:
             multi = i

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

@@ -8,7 +8,8 @@ import os
 from copy import deepcopy
 import shutil
 import pandas as pd
-from inspect import signature, getsource
+from inspect import signature, getsource, getfile
+from IPython.display import display, Markdown
 
 
 class MathSpec:
@@ -32,7 +33,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 +209,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.
 
@@ -1099,13 +1117,34 @@ class MathSpecImplementation:
 
     def load_source_files(self):
         self.source_files = {}
-        for key in self.components:
+        self.file_names = {}
+        for key in self.blocks:
             self.source_files[key] = getsource(self.components[key])
+            self.file_names[key] = getfile(self.components[key])
 
-    def print_source_code_files(self, keys=None):
+    def print_source_code_files(self, keys=None, markdown=True):
         if not keys:
             keys = list(self.source_files.keys())
         for key in keys:
+            # Skip wirings
+            if key not in self.ms.components:
+                continue
             print("-" * 20 + key + "-" * 20)
-            print(self.source_files[key])
+            if markdown:
+                display(
+                    Markdown(
+                        """```python
+{}
+```""".format(
+                            self.source_files[key]
+                        )
+                    )
+                )
+            else:
+                print(self.source_files[key])
+            print("\n")
+            full_path = self.file_names[key]
+            print("File path: {}".format(full_path))
+            relative_path = "./" + os.path.relpath(full_path, os.getcwd())
+            print("Relative file path: {}".format(relative_path))
             print("\n\n\n")

{math_spec_mapping-0.3.14 → math_spec_mapping-0.3.16}/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.16}/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.16}/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.16}/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.16}/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.16}/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.16}/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.16}/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.16}/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.16}/src/math_spec_mapping/Reports/markdown.py

@@ -1,5 +1,19 @@
 import os
 from .state import write_state_section
+from inspect import signature, getsource, getfile
+
+
+def get_source_code(ms, component_type, implementation_name):
+    if implementation_name in ms.implementations["python"][component_type]:
+        code = ms.implementations["python"][component_type][implementation_name]
+    else:
+        return None
+    source_code = """```python
+{}```""".format(
+        getsource(code)
+    )
+    file_path = getfile(code)
+    return source_code, file_path
 
 
 def write_entity_markdown_report(ms, path, entity, add_metadata=True):
@@ -157,6 +171,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):
@@ -167,7 +193,23 @@ def write_boundary_action_markdown_report(ms, path, boundary_action, add_metadat
 
             out += "#### Logic\n"
             out += x.logic
-            out += "\n\n"
+            out += "\n"
+
+            temp = get_source_code(ms, "boundary_action_options", x.name)
+            if temp:
+                source_code, file_path = temp
+                file_path = os.path.relpath(
+                    file_path, "{}/Boundary Actions".format(path)
+                )
+                out += "#### Python Implementation\n"
+                out += source_code
+                out += "\n"
+                out += "Implementation Path (only works if vault is opened at level including the src folder): [{}]({})".format(
+                    file_path, file_path
+                )
+                out += "\n"
+
+            out += "\n"
 
     with open(
         "{}/Boundary Actions/{}.md".format(path, boundary_action.label), "w"
@@ -244,7 +286,21 @@ def write_policy_markdown_report(ms, path, policy, add_metadata=True):
 
             out += "#### Logic\n"
             out += x.logic
-            out += "\n\n"
+            out += "\n"
+
+            temp = get_source_code(ms, "policies", x.name)
+            if temp:
+                source_code, file_path = temp
+                file_path = os.path.relpath(file_path, "{}/Policies".format(path))
+                out += "#### Python Implementation\n"
+                out += source_code
+                out += "\n"
+                out += "Implementation Path (only works if vault is opened at level including the src folder): [{}]({})".format(
+                    file_path, file_path
+                )
+                out += "\n"
+
+            out += "\n"
 
     with open("{}/Policies/{}.md".format(path, policy.label), "w") as f:
         f.write(out)
@@ -288,6 +344,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
 
@@ -299,6 +367,20 @@ def write_mechanism_markdown_report(ms, path, mechanism, add_metadata=True):
         )
         out += "\n"
 
+    temp = get_source_code(ms, "mechanisms", mechanism.name)
+    if temp:
+        source_code, file_path = temp
+        file_path = os.path.relpath(file_path, "{}/Mechanisms".format(path))
+        out += "## Python Implementation\n"
+        out += source_code
+        out += "\n"
+        out += "Implementation Path (only works if vault is opened at level including the src folder): [{}]({})".format(
+            file_path, file_path
+        )
+        out += "\n"
+
+    out += "\n"
+
     with open("{}/Mechanisms/{}.md".format(path, mechanism.label), "w") as f:
         f.write(out)
 
@@ -329,6 +411,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 +470,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)
@@ -390,7 +492,23 @@ def write_control_action_markdown_report(ms, path, control_action, add_metadata=
 
             out += "#### Logic\n"
             out += x.logic
-            out += "\n\n"
+            out += "\n"
+
+            temp = get_source_code(ms, "control_action_options", x.name)
+            if temp:
+                source_code, file_path = temp
+                file_path = os.path.relpath(
+                    file_path, "{}/Control Actions".format(path)
+                )
+                out += "#### Python Implementation\n"
+                out += source_code
+                out += "\n"
+                out += "Implementation Path (only works if vault is opened at level including the src folder): [{}]({})".format(
+                    file_path, file_path
+                )
+                out += "\n"
+
+            out += "\n"
 
     with open("{}/Control Actions/{}.md".format(path, control_action.label), "w") as f:
         f.write(out)
@@ -410,6 +528,13 @@ def write_wiring_markdown_report(ms, path, wiring, add_metadata=True):
 """.format(
                 "\n".join(["{}: {}".format(x, metadata[x]) for x in metadata])
             )
+    out += "## Wiring Diagram (Zoomed Out)"
+    out += "\n"
+    out += "\n"
+    out += "- For display of only depth of 1 in the components/nested wirings\n"
+    out += wiring.render_mermaid_root(go_deep="First")
+    out += "\n"
+    out += "\n"
 
     out += "## Wiring Diagram"
     out += "\n"
@@ -463,6 +588,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.16/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.16
 Summary: A library for easy mapping of mathematical specifications.
 Author-email: Sean McOwen <Sean@Block.Science>
 Classifier: Programming Language :: Python :: 3