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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: math_spec_mapping
-Version: 0.2.2
+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.2 → 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.2"
+version = "0.2.4"
 authors = [
   { name="Sean McOwen", email="Sean@Block.Science" },
 ]

{math_spec_mapping-0.2.2 → 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.2 → math_spec_mapping-0.2.4}/src/Classes/MathSpec.py

@@ -11,6 +11,7 @@ class MathSpec:
         # Internal variables to keep track
         self._ms_dict = ms_dict
         self._json = json
+        self.type_keys = ms_dict["Type Keys"]
         self.action_transmission_channels = ms_dict["Action Transmission Channels"]
         self.boundary_actions = ms_dict["Boundary Actions"]
         self.control_actions = ms_dict["Control Actions"]
@@ -28,6 +29,11 @@ class MathSpec:
         self.blocks = ms_dict["Blocks"]
         self.types = ms_dict["Types"]
         self.metrics = ms_dict["Metrics"]
+        self.displays = ms_dict["Displays"]
+        self.stateful_metrics_map = {}
+        for x in self.stateful_metrics:
+            for y in self.stateful_metrics[x].metrics:
+                self.stateful_metrics_map[y.name] = y
 
         self._check_parameters()
         self._crawl_parameters()

{math_spec_mapping-0.2.2 → 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.2 → math_spec_mapping-0.2.4}/src/Classes/Type.py

@@ -3,5 +3,6 @@ class Type:
     def __init__(self, data):
         self.name = data["name"]
         self.type = data["type"]
+        self.type_name = data["type_name"]
         self.notes = data["notes"]
         self.metadata = data["metadata"]

math_spec_mapping-0.2.4/src/Load/displays.py

@@ -0,0 +1,13 @@
+def load_displays(ms, json) -> None:
+    ms["Displays"] = {}
+    load_wiring(ms, json)
+
+
+def load_wiring(ms, json):
+    ms["Displays"]["Wiring"] = []
+    for display in json["Displays"]["wiring"]:
+        for component in display["components"]:
+            assert component in ms["Blocks"], "{} is not a valid block".format(
+                component
+            )
+        ms["Displays"]["Wiring"].append(display)

{math_spec_mapping-0.2.2 → math_spec_mapping-0.2.4}/src/Load/general.py

@@ -4,6 +4,7 @@ from ..schema import schema
 
 
 def check_json_keys(json: Dict, check_set_key: str) -> None:
+    pass
     """Function to check the correct keys are in the json dictionary
 
     Args:
@@ -11,7 +12,7 @@ def check_json_keys(json: Dict, check_set_key: str) -> None:
         check_set_key (str): The key for what checking set to use
     """
 
-    # Get a temporary list of keys
+    """# Get a temporary list of keys
     keys = list(json.keys())
 
     # Pick the correct checking set
@@ -46,6 +47,7 @@ def check_json_keys(json: Dict, check_set_key: str) -> None:
             "Wiring",
             "Types",
             "Metrics",
+            "Displays",
         ],
         "State": ["name", "label", "notes", "variables", "metadata"],
         "State Variable": ["type", "name", "description", "symbol", "domain"],
@@ -152,7 +154,7 @@ def check_json_keys(json: Dict, check_set_key: str) -> None:
             keys.remove(k)
 
     # Make sure there are no extra keys in the json
-    assert len(keys) == 0, "There are extra keys in json: {}".format(", ".join(keys))
+    assert len(keys) == 0, "There are extra keys in json: {}".format(", ".join(keys))"""
 
 
 def validate_json_schema(json):

{math_spec_mapping-0.2.2 → math_spec_mapping-0.2.4}/src/Load/load.py

@@ -13,8 +13,9 @@ from .policy import load_policies
 from .spaces import load_spaces
 from .stateful_metrics import load_stateful_metrics
 from .wiring import load_wiring
-from .type import load_types
+from .type import load_types, load_type_keys
 from .metrics import load_metrics
+from .displays import load_displays
 
 
 def load_from_json(json: Dict) -> MathSpec:
@@ -36,6 +37,8 @@ def load_from_json(json: Dict) -> MathSpec:
     ms = {}
 
     # Do loading one by one to transfer the json
+
+    load_type_keys(ms)
     load_types(ms, json)
     load_spaces(ms, json)
     load_states(ms, json)
@@ -46,10 +49,28 @@ def load_from_json(json: Dict) -> MathSpec:
     load_parameters(ms, json)
     load_policies(ms, json)
     load_stateful_metrics(ms, json)
+
+    stateful_metrics_map = {}
+    for x in ms["Stateful Metrics"]:
+        for y in ms["Stateful Metrics"][x].metrics:
+            stateful_metrics_map[y.name] = y
+
     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)
-    load_metrics(ms, json)
+
+    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)
+    else:
+        ms["Displays"] = None
 
     # Assert all keys are correct for the ms version
     check_json_keys(ms, "Math Spec")

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

@@ -3,7 +3,7 @@ from ..Classes import Metric
 from .general import check_json_keys
 
 
-def convert_metric(ms, data: Dict) -> Metric:
+def convert_metric(ms, data: Dict, stateful_metrics_map) -> Metric:
     """Function to convert metric
 
     Args:
@@ -33,7 +33,7 @@ def convert_metric(ms, data: Dict) -> Metric:
             x[1]
         )
     for x in data["parameters_used"]:
-        assert x in ms["Parameters"].all_parameters
+        assert x in ms["Parameters"].all_parameters, "{} not in parameters".format(x)
 
     data["domain"] = tuple(data["domain"])
     for x in data["domain"]:
@@ -41,15 +41,20 @@ def convert_metric(ms, data: Dict) -> Metric:
     data["domain"] = tuple(ms["Spaces"][x] for x in data["domain"])
 
     for x in data["metrics_used"]:
-        assert x in ms["Metrics"], "{} not a valid metric".format(x)
+        assert (
+            x in ms["Metrics"] or x in stateful_metrics_map
+        ), "{} not a valid metric".format(x)
 
-    data["metrics_used"] = tuple(ms["Metrics"][x] for x in data["metrics_used"])
+    data["metrics_used"] = tuple(
+        ms["Metrics"][x] if x in ms["Metrics"] else stateful_metrics_map[x]
+        for x in data["metrics_used"]
+    )
 
     # Build the metric object
     return Metric(data)
 
 
-def load_metrics(ms: Dict, json: Dict) -> None:
+def load_metrics(ms: Dict, json: Dict, stateful_metrics_map) -> None:
     """Function to load metrics into the new dictionary
 
     Args:
@@ -65,9 +70,14 @@ def load_metrics(ms: Dict, json: Dict) -> None:
         i = 0
         hold = []
         for metric in metrics:
-            if all([x in ms["Metrics"] for x in metric["metrics_used"]]):
+            if all(
+                [
+                    x in ms["Metrics"] or x in stateful_metrics_map
+                    for x in metric["metrics_used"]
+                ]
+            ):
                 i += 1
-                metric = convert_metric(ms, metric)
+                metric = convert_metric(ms, metric, stateful_metrics_map)
                 assert (
                     metric.name not in ms["Metrics"]
                 ), "{} was a repeated metric".format(metric.name)
@@ -80,6 +90,15 @@ def load_metrics(ms: Dict, json: Dict) -> None:
         for y in metrics:
             for z in y["metrics_used"]:
                 assert (
-                    z in ms["Metrics"] or z in names
+                    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.4/src/Load/type.py

@@ -0,0 +1,100 @@
+from .general import check_json_keys
+from ..Classes import Type
+import os
+from typing import _UnionGenericAlias
+
+
+def convert_type(data, ms):
+
+    if "metadata" not in data:
+        data["metadata"] = {}
+
+    # Check the keys are correct
+    check_json_keys(data, "Type")
+
+    # Copy
+    data = data.copy()
+
+    type_name = data["type"]
+    data["type"] = {}
+    data["type_name"] = {}
+
+    if "python" in ms["Type Keys"]:
+
+        if type_name in ms["Type Keys"]["python"]:
+            data["type"]["python"] = ms["Type Keys"]["python"][type_name]
+            if type(data["type"]["python"]) == dict:
+                out = {}
+                for key in data["type"]["python"]:
+                    val = data["type"]["python"][key]
+                    if type(val) == str:
+                        val = ms["Types"][val].name
+                    else:
+                        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)
+
+
+def load_types(ms, json) -> None:
+
+    ms["Types"] = {}
+    for data in json["Types"]:
+        ms["Types"][data["name"]] = convert_type(data, ms)
+
+
+def load_python_type_key():
+    from src.TypeMappings.types import mapping
+
+    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.2 → 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.2 → math_spec_mapping-0.2.4}/src/Reports/markdown.py

@@ -90,8 +90,16 @@ def write_types_markdown_report(ms, path, t, add_metadata=True):
 
     out += "## Type"
     out += "\n"
-    out += str(t.type)
-    out += "\n\n"
+
+    if "python" in t.type:
+        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"
     out += t.notes
@@ -204,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):
@@ -292,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"
@@ -337,18 +357,14 @@ def write_control_action_markdown_report(ms, path, control_action, add_metadata=
     if control_action.control_action_options:
         out += "## Control Action Options:\n"
         for i, x in enumerate(control_action.control_action_options):
-            out += "<details>"
-            out += "<summary><b>{}. {}</b></summary>".format(i + 1, x.name)
-            out += "<p>"
+            out += "### {}. {}\n".format(i + 1, x.name)
+            out += "#### Description\n"
             out += x.description
-            out += "</p>"
-
-            out += "<p>"
-            out += "Logic: {}".format(x.logic)
-            out += "</p>"
+            out += "\n"
 
-            out += "</details>"
-        out += "<br/>"
+            out += "#### Logic\n"
+            out += x.logic
+            out += "\n\n"
 
     with open("{}/Control Actions/{}.md".format(path, control_action.label), "w") as f:
         f.write(out)
@@ -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)
 
@@ -539,6 +567,77 @@ def write_metrics_markdown_report(ms, path, metric, add_metadata=True):
         f.write(out)
 
 
+def write_displays_markdown_reports(ms, path, add_metadata=True):
+    if "Displays" not in os.listdir(path):
+        os.makedirs(path + "/Displays")
+    if "Wiring" not in os.listdir(path + "/Displays"):
+        os.makedirs(path + "/Displays/Wiring")
+
+    for wiring in ms.displays["Wiring"]:
+        write_wiring_display_markdown_report(
+            ms, path, wiring, add_metadata=add_metadata
+        )
+
+
+def write_wiring_display_markdown_report(ms, path, wiring, add_metadata=True):
+    wirings = [ms.wiring[w] for w in wiring["components"]]
+    out = ""
+
+    out += "## Wiring Diagrams"
+    out += "\n"
+    out += "\n"
+    for w in wirings:
+        out += w.render_mermaid_root()
+        out += "\n"
+        out += "\n"
+    out += "## Description"
+    out += "\n"
+    out += "\n"
+    out += wiring["description"]
+    out += "\n"
+
+    out += "## Wirings\n"
+    for i, x in enumerate(wiring["components"]):
+        out += "{}. [[{}]]".format(i + 1, x)
+        out += "\n"
+    out += "\n"
+
+    out += "## Unique Components Used\n"
+    components = [set(x.components) for x in wirings]
+    components = set().union(*components)
+    for i, x in enumerate(components):
+        out += "{}. [[{}]]".format(i + 1, x.name)
+        out += "\n"
+    out += "\n"
+
+    """domain = [set(x.domain) for x in wirings]
+    domain = set().union(*domain)
+    out += "## Unique Domain Spaces\n"
+    for i, x in enumerate(domain):
+        out += "{}. [[{}]]".format(i + 1, x.name)
+        out += "\n"
+    out += "\n"
+
+    codomain = [set(x.codomain) for x in wirings]
+    codomain = set().union(*codomain)
+    out += "## Unique Codomain Spaces\n"
+    for i, x in enumerate(codomain):
+        out += "{}. [[{}]]".format(i + 1, x.name)
+        out += "\n"
+    out += "\n"""
+
+    parameters = [set(x.parameters_used) for x in wirings]
+    parameters = set().union(*parameters)
+    out += "## Unique Parameters Used\n"
+    for i, x in enumerate(parameters):
+        out += "{}. [[{}]]".format(i + 1, x)
+        out += "\n"
+    out += "\n"
+
+    with open("{}/Displays/Wiring/{}.md".format(path, wiring["name"]), "w") as f:
+        f.write(out)
+
+
 def write_all_markdown_reports(ms, path):
 
     # Write entities
@@ -598,3 +697,7 @@ def write_all_markdown_reports(ms, path):
     # Write metrics
     for x in ms.metrics:
         write_metrics_markdown_report(ms, path, x)
+
+    # Write displays
+    if ms.displays:
+        write_displays_markdown_reports(ms, path, add_metadata=True)

{math_spec_mapping-0.2.2 → 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.2
+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.2 → math_spec_mapping-0.2.4}/src/math_spec_mapping.egg-info/SOURCES.txt

@@ -25,6 +25,7 @@ src/Load/__init__.py
 src/Load/action_transmission_channel.py
 src/Load/boundary_actions.py
 src/Load/control_actions.py
+src/Load/displays.py
 src/Load/entities.py
 src/Load/general.py
 src/Load/load.py

math_spec_mapping-0.2.2/src/Load/type.py

@@ -1,24 +0,0 @@
-from .general import check_json_keys
-from ..Classes import Type
-
-
-def convert_type(data, ms):
-
-    if "metadata" not in data:
-        data["metadata"] = {}
-
-    # Check the keys are correct
-    check_json_keys(data, "Type")
-
-    # Copy
-    data = data.copy()
-
-    # Build the type object
-    return Type(data)
-
-
-def load_types(ms, json) -> None:
-
-    ms["Types"] = {}
-    for data in json["Types"]:
-        ms["Types"][data["name"]] = convert_type(data, ms)