math-spec-mapping 0.2.3__py3-none-any.whl → 0.2.4__py3-none-any.whl

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

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"]

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)

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])

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

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)

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.dist-info → math_spec_mapping-0.2.4.dist-info}/METADATA

@@ -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.dist-info → math_spec_mapping-0.2.4.dist-info}/RECORD

@@ -1,7 +1,7 @@
 __init__.py,sha256=bWYy9HVSz89bN8y7H7fP7Xrd1TLliPp73zWBUe3KuFE,846
 schema.py,sha256=6mrRqzEnTTSXjb19xJ63MBp0KjKH0s7i6TfT4MkAY9k,233
 Classes/ActionTransmissionChannel.py,sha256=zWMo5QsgPh5WGIWXl-xOrZNMXYJXmK6Vejw1dQvi0og,246
-Classes/Block.py,sha256=ZBGzwMy_mcGGPMjM78n4MT06G-8rtWHfg2O1Fa1ghL4,14058
+Classes/Block.py,sha256=HUM_ziEE40DBy_mG-XFnHjg3MTTO2C5e6ONyZIAy77Q,17000
 Classes/BoundaryAction.py,sha256=AOENCqCEfpjotnHhzUj_F2SOP0SGpkN1tNPr8Mtl6Tc,476
 Classes/ControlAction.py,sha256=xaU3_WVeWOoOFX3O86x30_9Eiirfe76KrO3M2kfjcmo,471
 Classes/Entity.py,sha256=fA0-b128_OHHxfCg4pzqyQV083EYev1HlVpy86S5igg,1226
@@ -9,7 +9,7 @@ Classes/MathSpec.py,sha256=P4FPfv6tpbrY1ytmOQ61hXBey83YoCMgMKOpo6xikxU,13230
 Classes/Mechanism.py,sha256=7jj6bcPI6H2iv1VZZTlpbG4G2k9s4MYkrH8Sfj9uGM4,324
 Classes/Metric.py,sha256=AhPgYppOP6q49xvR8S9STxQsXUKJlTWx7wI1LfZEtww,581
 Classes/Parameter.py,sha256=ZuJ_w0sChvRElJ4sOnXZ2EV4Ell2xXFulKLjVOpgz2E,1237
-Classes/Policy.py,sha256=r0m9oCeAYun2ujoEH0BasuknFV4Rsvlu4Obq4TUO8zk,426
+Classes/Policy.py,sha256=HUEooO4Liy7olmHwegb6A-hcreNMNCevl9QKKwOjSik,475
 Classes/Space.py,sha256=96Cdi8ERkfsgJnh5UyhecKiuU4hWwI6w-i1U1jtwX6A,398
 Classes/State.py,sha256=Mdn0D21G198f6q13-2tVBYUbnzhRwoDivWpFtH4XJq0,1423
 Classes/StateUpdateTransmissionChannel.py,sha256=3hBLvD1lE64PkwqksBXAfFWv7foOZzGQLAFQWy42tOA,257
@@ -25,23 +25,23 @@ Load/control_actions.py,sha256=VmjezReijEqe9cdPHQubGZTGVPsYbMzWfLu5Dfm9WvY,1563
 Load/displays.py,sha256=ooHWT_OryzEkp7F3LcGywwdLMRJLxuyPK82zJ3gcyN0,414
 Load/entities.py,sha256=rMD_Pja-zqH1Z14rsO_Ia7dg3BIi5_HoQmqGAoEYofA,1208
 Load/general.py,sha256=2q6aGKxXhebiHHTZhtACvM4nWIkTben0o5rXuvfv2Vw,4463
-Load/load.py,sha256=7vw-dQ6BADQ3dblxhXNvDRkxM9W7zP_epahsmdt1Qkg,2233
+Load/load.py,sha256=VEiZRsiO3QQnw5ZIJ0RQzgQ5hKoWLz6b36Zv9tG-XvI,2405
 Load/mechanism.py,sha256=aIpMzgQn8f1aywgOHxL5kHQUn1N8K9pmHOVs51bv3Hk,1673
-Load/metrics.py,sha256=wj9Auk9jPYyT2dR55_YiMFhmf-wRUN1bYcmT7XytrcE,2939
+Load/metrics.py,sha256=gD68mt0Y5jSgofZUwscV8PFatOMV_LPwYyPrwV9SdtE,3273
 Load/parameters.py,sha256=aid_vqYub9643s82NDtMAXLRdV9BPQkri5MadA0L0eQ,1334
 Load/policy.py,sha256=fDBuOe1LWw-6C_xcYtvtx9dpjWoD9GNEumW7bK8QaT0,2077
 Load/spaces.py,sha256=7zgGA57Te7T4hfuCCDElffiidWgn1lKm5E14e1yjt8M,1116
 Load/state_update_transmission_channels.py,sha256=FJWp5n4HdtHAfof5BUQ6BnRakljatL2h8dWCapaVSc0,2238
 Load/stateful_metrics.py,sha256=Z4S1BWVRfE0cGtcUikJnhmYLKW4k1CurAPrOfjObSKo,1795
 Load/states.py,sha256=cwo29SBAtj1FoQLEb8c0wkSCn038lIgM9RjNiZefUaE,1223
-Load/type.py,sha256=OrnxUEbiPaO_qbM457Wfg45RZK0jven8kEBG0qkSBKw,1559
+Load/type.py,sha256=cKfeLAmYG4hl4mxYA3FvWoQt16ReWrL64H98wgehp6U,3043
 Load/wiring.py,sha256=1dR94U5N1W_WI5rL6lYBltH25ZvApB2pIpq9r5Opkug,3083
 Reports/__init__.py,sha256=W27I6S9Ro1hWeHmnxIokCA06awB__eYey7PvKD4Hc1s,933
 Reports/boundary_actions.py,sha256=45BPp4QjWdD-3E9ZWwqgj_nI2-YdcI2ZZ19_Qv_K7Qk,1410
 Reports/control_actions.py,sha256=NksekZKIPFSIkubttFstKFthc5AU9B9PWRLSl9j1wWs,1216
 Reports/general.py,sha256=WOOn6Wlb8M4fsdN49FlKLwOka6vJPQ9aCUy88TL2ki0,1610
-Reports/html.py,sha256=EKuQg7PwhvY0NDZtJj1nVTZeSheez8PDAsj43tdtvio,7737
-Reports/markdown.py,sha256=rRg0hb1194_GySapHV5QULY2F1An2WPnMeceOa7Bt-w,18834
+Reports/html.py,sha256=4wpry61_URAc_LeVemQWowVWGlhMwayjaS3eyUSm0rM,7866
+Reports/markdown.py,sha256=j5QYmk9HXZK9mL3LQqJaW7FJ9oqCmBpEfmvtElljiso,19643
 Reports/mechanisms.py,sha256=d2Rxt3JBYvqAOAYUynl0buYVoXEHrO8EGq7GK6hK8NA,1322
 Reports/node_map.py,sha256=FdSMDQG16NX6n9sZcH-T5xwsvgjrV9OqBHc9J_VlNK0,3129
 Reports/parameters.py,sha256=yizNG4lNGrgrlzYYcHMGfXKDFlPw4PMDYshDqZ3YARs,535
@@ -50,8 +50,8 @@ Reports/spaces.py,sha256=-76hR5wQBv4lsG000ypBJ-OprjsNjI-rNRMYdtsYnjQ,579
 Reports/state.py,sha256=RSHDjzSiUj4ZjReWbkBW7k2njs3Ovp-q0rCC7GBfD-A,2203
 Reports/tables.py,sha256=O0CNuqh3LMECq5uLjBOoxMUk5hUvkUK660FNnwWUxDY,1505
 Reports/wiring.py,sha256=u9SvKWy6T-WJUEgFI6-zgZanoOaTTs_2YwmEceDLsV8,1618
-math_spec_mapping-0.2.3.dist-info/LICENSE,sha256=ObyEzSw8kgCaFbEfpu1zP4TrcAKLA0xhqHMZZfyh7N0,1069
-math_spec_mapping-0.2.3.dist-info/METADATA,sha256=KF7R2dbr_jh2lpQd5aphqDxB9QxeIbq5Dng_h-f7C-Y,5898
-math_spec_mapping-0.2.3.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-math_spec_mapping-0.2.3.dist-info/top_level.txt,sha256=DKHirRZ28B4EfLjV3iAU31Sdj6q90EDPTSkRGRZf3uo,49
-math_spec_mapping-0.2.3.dist-info/RECORD,,
+math_spec_mapping-0.2.4.dist-info/LICENSE,sha256=ObyEzSw8kgCaFbEfpu1zP4TrcAKLA0xhqHMZZfyh7N0,1069
+math_spec_mapping-0.2.4.dist-info/METADATA,sha256=LuLoWfDUlm2t-bKaYix2Pc6C4Fdzq-jVBJ1meGJKKsc,5898
+math_spec_mapping-0.2.4.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+math_spec_mapping-0.2.4.dist-info/top_level.txt,sha256=DKHirRZ28B4EfLjV3iAU31Sdj6q90EDPTSkRGRZf3uo,49
+math_spec_mapping-0.2.4.dist-info/RECORD,,