math-spec-mapping 0.2.3__tar.gz → 0.2.4__tar.gz

{math_spec_mapping-0.2.3 → math_spec_mapping-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: math_spec_mapping
-Version: 0.2.3
+Version: 0.2.4
 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.2.3 → math_spec_mapping-0.2.4}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools>=61.0"]
 build-backend = "setuptools.build_meta"
 [project]
 name = "math_spec_mapping"
-version = "0.2.3"
+version = "0.2.4"
 authors = [
   { name="Sean McOwen", email="Sean@Block.Science" },
 ]

{math_spec_mapping-0.2.3 → math_spec_mapping-0.2.4}/src/Classes/Block.py

@@ -21,6 +21,7 @@ class Block:
             self.called_by = []
         self.calls = []
         self.block_type = "Block"
+        self.all_updates = []
         # Will be overwritten in composite blocks to represent individual components
         self.domain_blocks = tuple(
             [
@@ -61,16 +62,85 @@ class Block:
             for _ in range(len([x for x in self.codomain if x == TerminatingSpace]))
         )
 
+        self.find_all_spaces_used(data)
+
     def render_mermaid(self, i):
         i += 1
-        return "X{}[{}]".format(i, self.name), i
+        out = 'X{}["{}"]'.format(i, self.name)
+        if self.block_type == "Mechanism":
+            for u in self.updates:
+                out += "\n"
+                out += "X{} --> {}".format(
+                    i,
+                    (u[0].name + "-" + u[1].name).replace(" ", "-"),
+                )
+        return out, i
+
+    def render_ending_entities(self):
+        if self.block_type == "Mechanism":
+            updates = self.updates
+        elif self.block_type in ["Parallel Block", "Stack Block", "Split Block"]:
+            updates = self.all_updates
+        else:
+            return "\n", {}
+
+        out = "\n"
+        out += 'subgraph SVS["State Variables"]\n'
+
+        # Render the entities
+        entity_mapping = {}
+        entities = set([x[0] for x in updates])
+        for i, x in enumerate(entities):
+            entity_mapping[x.name] = "EE{}".format(i)
+            out += '{}[("{}")]'.format(entity_mapping[x.name], x.name)
+            out += "\n"
+
+        entity_variable_mapping = {}
+        # Render the state variables
+        for i, x in enumerate(updates):
+            entity_variable_mapping[(x[0].name + "-" + x[1].name).replace(" ", "-")] = (
+                "EES{}".format(i)
+            )
+            out += '{}(["{}"])'.format("EES{}".format(i), x[1].name)
+            out += "\n"
+
+            out += "{} --- {}".format("EES{}".format(i), entity_mapping[x[0].name])
+            out += "\n"
+        out += "end\n"
+        out += "\n"
+        return out, entity_variable_mapping
 
     def render_mermaid_root(self):
         out = """```mermaid\ngraph TB\n"""
+        add, entity_variable_mapping = self.render_ending_entities()
+        out += add
         out += self.render_mermaid(0)[0]
+
+        for key in entity_variable_mapping:
+            out = out.replace(key, entity_variable_mapping[key])
         out += "\n```"
+
         return out
 
+    def find_all_spaces_used(self, data):
+        self.all_spaces_used = []
+        self.all_spaces_used.extend(self.domain)
+        self.all_spaces_used.extend(self.codomain)
+        if "components" in data:
+            for x in data["components"]:
+                self.all_spaces_used.extend(x.all_spaces_used)
+        self.all_spaces_used = list(set(self.all_spaces_used))
+
+    def find_all_updates(self, data):
+        self.all_updates = []
+        if "components" in data:
+            for x in data["components"]:
+                if x.block_type == "Mechanism":
+                    self.all_updates.extend(x.updates)
+                else:
+                    self.all_updates.extend(x.all_updates)
+        self.all_updates = list(set(self.all_updates))
+
 
 class ParallelBlock(Block):
     def __init__(self, data: Dict):
@@ -123,8 +193,9 @@ class ParallelBlock(Block):
 
         self.called_by = []
         self.calls = []
-        self.block_type = "Paralell Block"
+        self.block_type = "Parallel Block"
         self.metadata = data["metadata"]
+        self.find_all_spaces_used(data)
 
     def render_mermaid(self, i):
         multi = None
@@ -139,6 +210,7 @@ class ParallelBlock(Block):
         # Render components
         domain_map = {}
         codomain_map = {}
+
         for component in self.components:
             domain = component.domain
             codomain = component.codomain
@@ -182,22 +254,27 @@ class ParallelBlock(Block):
         for ix1 in nodes:
             d = domain_map[ix1]
             if len(d) > 0:
+                d_length = len(d)
                 d = "\n".join(d)
                 d = '"{}"'.format(d)
-                out += "X{} --{}--> X{}".format(domain_i, d, ix1)
+                out += "X{} --{}{}-> X{}".format(domain_i, d, "-" * d_length, ix1)
             else:
                 out += "X{} --> X{}".format(domain_i, ix1)
             out += "\n"
 
+        codomain_connections = 0
         for ix1 in nodes:
             d = codomain_map[ix1]
             if len(d) > 0:
                 d = "\n".join(d)
                 d = '"{}"'.format(d)
                 out += "X{} --{}--> X{}".format(ix1, d, codomain_i)
-            else:
-                out += "X{} --> X{}".format(ix1, codomain_i)
-            out += "\n"
+                codomain_connections += 1
+                out += "\n"
+            # else:
+            #    out += "X{} --> X{}".format(ix1, codomain_i)
+        if codomain_connections == 0:
+            out = out.replace("X{}[Codomain]".format(codomain_i), "")
 
         # Subgraph it
         if self.mermaid_show_name:
@@ -205,7 +282,7 @@ class ParallelBlock(Block):
         else:
             name = " "
         i += 1
-        out = "subgraph X{}[{}]\ndirection TB\n".format(i, name) + out
+        out = 'subgraph X{}["{}"]\ndirection TB\n'.format(i, name) + out
 
         out += "end"
 
@@ -241,6 +318,7 @@ class StackBlock(Block):
 
         self.block_type = "Stack Block"
         self.metadata = data["metadata"]
+        self.find_all_spaces_used(data)
 
     def _check_domain_mapping(self):
         x = self.components[:-1]
@@ -340,12 +418,13 @@ class StackBlock(Block):
                     d = domain_map[ix4]
                     optional = global_optional
                     if len(d) > 0:
+                        d_length = len(d)
                         d = "\n".join(d)
                         d = '"{}"'.format(d)
                         if optional:
-                            out += "X{}-.{}.->X{}".format(ix3, d, ix4)
+                            out += "X{}-.{}.{}->X{}".format(ix3, d, "." * d_length, ix4)
                         else:
-                            out += "X{}--{}-->X{}".format(ix3, d, ix4)
+                            out += "X{}--{}-{}->X{}".format(ix3, d, "-" * d_length, ix4)
                     else:
                         if optional:
                             out += "X{}-.->X{}".format(ix3, ix4)
@@ -359,7 +438,7 @@ class StackBlock(Block):
         else:
             name = " "
         i += 1
-        out = "subgraph X{}[{}]\ndirection TB\n".format(i, name) + out
+        out = 'subgraph X{}["{}"]\ndirection TB\n'.format(i, name) + out
         out += "end"
 
         return out, i
@@ -419,6 +498,7 @@ class SplitBlock(Block):
 
         self.block_type = "Split Block"
         self.metadata = data["metadata"]
+        self.find_all_spaces_used(data)
 
     def render_mermaid(self, i):
         multi = None

{math_spec_mapping-0.2.3 → math_spec_mapping-0.2.4}/src/Classes/Policy.py

@@ -14,3 +14,4 @@ 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.2.3 → math_spec_mapping-0.2.4}/src/Load/load.py

@@ -58,6 +58,14 @@ def load_from_json(json: Dict) -> MathSpec:
     action_transmission_channels = load_wiring(ms, json)
     load_action_transmission_channels(ms, action_transmission_channels)
     load_state_update_transmission_channels(ms, state_update_transmission_channels)
+
+    temp = {}
+    for w in json["Wiring"]:
+        temp[w["name"]] = w
+    for w in ms["Wiring"]:
+        w = temp[w]
+        ms["Wiring"][w["name"]].find_all_updates(w)
+
     load_metrics(ms, json, stateful_metrics_map)
     if "Displays" in json:
         load_displays(ms, json)

{math_spec_mapping-0.2.3 → math_spec_mapping-0.2.4}/src/Load/metrics.py

@@ -93,3 +93,12 @@ def load_metrics(ms: Dict, json: Dict, stateful_metrics_map) -> None:
                     z in ms["Metrics"] or z in names or z in stateful_metrics_map
                 ), "{} is not defined in the spec".format(z)
         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 x in hold:
+            assert x in ms["Metrics"], "{} not a valid metric".format(x)
+            policy.metrics_used.append(ms["Metrics"][x])

{math_spec_mapping-0.2.3 → math_spec_mapping-0.2.4}/src/Load/type.py

@@ -1,6 +1,7 @@
 from .general import check_json_keys
 from ..Classes import Type
 import os
+from typing import _UnionGenericAlias
 
 
 def convert_type(data, ms):
@@ -32,8 +33,13 @@ def convert_type(data, ms):
                         val = val.__name__
                     out[key] = val
                 data["type_name"]["python"] = str(out)
+            elif type(data["type"]["python"]) == _UnionGenericAlias:
+                data["type_name"]["python"] = data["type"]["python"].__repr__()
             else:
                 data["type_name"]["python"] = data["type"]["python"].__name__
+        if type_name in ms["Type Keys"]["typescript"]:
+            data["type"]["typescript"] = ms["Type Keys"]["typescript"][type_name]
+            data["type_name"]["typescript"] = ms["Type Keys"]["typescript"][type_name]
 
     # Build the type object
     return Type(data)
@@ -52,10 +58,43 @@ def load_python_type_key():
     return mapping
 
 
+def load_typescript_type_key(path):
+    with open(path, "r") as file:
+        type_definitions = file.read()
+    type_definitions = type_definitions.split("\n")
+    type_definitions = [x for x in type_definitions if len(x) > 0]
+    hold = type_definitions[:]
+    type_definitions = []
+    type_definitions.append(hold.pop(0))
+    while len(hold) > 0:
+        curr = hold.pop(0)
+        if "type" in curr or "interface" in curr:
+            type_definitions.append(curr)
+        else:
+            type_definitions[-1] += "\n" + curr
+
+    hold = type_definitions[:]
+    type_definitions = {}
+    for x in hold:
+        name = x
+        if x.startswith("type"):
+            name = name[5:]
+        elif x.startswith("interface"):
+            name = name[10:]
+        else:
+            assert False
+        name = name[: name.index("=")].strip()
+        type_definitions[name] = x
+    return type_definitions
+
+
 def load_type_keys(ms) -> dict:
     type_keys = {}
     python_path = "src/TypeMappings/types.py"
+    typescript_path = "src/TypeMappings/types.ts"
     if os.path.exists(python_path):
         type_keys["python"] = load_python_type_key()
+    if os.path.exists(typescript_path):
+        type_keys["typescript"] = load_typescript_type_key(typescript_path)
 
     ms["Type Keys"] = type_keys

{math_spec_mapping-0.2.3 → math_spec_mapping-0.2.4}/src/Reports/html.py

@@ -111,7 +111,9 @@ def write_entity_reports(ms: MathSpec, directory: str, entities: List[str]) -> N
             f.write(out)
 
 
-def write_spec_tree(ms: MathSpec, path=None, linking=False, add_tabbing=False) -> str:
+def write_spec_tree(
+    ms: MathSpec, path=None, linking=False, add_tabbing=False, readme=False
+) -> str:
     """Write the tree of the specification structure
 
     Args:
@@ -198,6 +200,9 @@ def write_spec_tree(ms: MathSpec, path=None, linking=False, add_tabbing=False) -
         out = out.split("\n")
         out = ["\t" + x for x in out]
         out = "\n".join(out)
+    if readme:
+        out = "\n\n```\n{}\n```".format(out)
+        out = out.replace("**", "")
 
     if path:
         with open("{}/Spec Tree.md".format(path), "w") as f:
@@ -211,6 +216,6 @@ def write_overview(ms: MathSpec, name: str, file_path: str, summary: str = None)
         out += "<h2>Summary</h2>"
         out += "<p>{}</p>".format(summary)
     out += "<h2>Specification Tree</h2>"
-    out += write_spec_tree(ms)
+    out += write_spec_tree(ms, readme=True)
     with open(file_path, "w") as f:
         f.write(out)

{math_spec_mapping-0.2.3 → math_spec_mapping-0.2.4}/src/Reports/markdown.py

@@ -95,6 +95,10 @@ def write_types_markdown_report(ms, path, t, add_metadata=True):
         out += "### Python Type\n"
         out += t.type_name["python"]
         out += "\n"
+    if "typescript" in t.type:
+        out += "### Typescript Type\n"
+        out += t.type_name["typescript"]
+        out += "\n"
     out += "\n"
     out += "## Notes"
     out += "\n\n"
@@ -208,6 +212,16 @@ def write_policy_markdown_report(ms, path, policy, add_metadata=True):
         out += "{}. {}".format(i + 1, x)
         out += "\n"
 
+    out += "## Parameters Used\n"
+    for i, x in enumerate(policy.parameters_used):
+        out += "{}. [[{}]]".format(i + 1, x)
+        out += "\n"
+
+    out += "## Metrics Used\n"
+    for i, x in enumerate(policy.metrics_used):
+        out += "{}. [[{}]]".format(i + 1, x.name)
+        out += "\n"
+
     if policy.policy_options:
         out += "## Policy Options\n"
         for i, x in enumerate(policy.policy_options):
@@ -296,7 +310,9 @@ def write_space_markdown_report(ms, path, space, add_metadata=True):
     out += "\n"
     out += "\n"
     d = space.schema
-    d = ",\n".join(["{}: {}".format(a, b.name) for a, b in zip(d.keys(), d.values())])
+    d = ",\n".join(
+        ["{}: [[{}]]".format(a, b.name) for a, b in zip(d.keys(), d.values())]
+    )
     d = "{" + d + "}"
     out += d
     out += "\n"
@@ -408,6 +424,12 @@ def write_wiring_markdown_report(ms, path, wiring, add_metadata=True):
         out += "\n"
     out += "\n"
 
+    out += "## All Spaces Used\n"
+    for i, x in enumerate(wiring.all_spaces_used):
+        out += "{}. [[{}]]".format(i + 1, x.name)
+        out += "\n"
+    out += "\n"
+
     out += "## Parameters Used\n"
     for i, x in enumerate(wiring.parameters_used):
         out += "{}. [[{}]]".format(i + 1, x)
@@ -426,6 +448,12 @@ def write_wiring_markdown_report(ms, path, wiring, add_metadata=True):
         out += "\n"
     out += "\n"
 
+    out += "## All State Updates\n"
+    for i, x in enumerate(wiring.all_updates):
+        out += "{}. [[{}]].{}".format(i + 1, x[0].name, x[1].name)
+        out += "\n"
+    out += "\n"
+
     with open("{}/Wiring/{}.md".format(path, wiring.name), "w") as f:
         f.write(out)
 

{math_spec_mapping-0.2.3 → math_spec_mapping-0.2.4}/src/math_spec_mapping.egg-info/PKG-INFO

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