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

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

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

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

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

@@ -141,6 +141,18 @@ class Block:
                     self.all_updates.extend(x.all_updates)
         self.all_updates = list(set(self.all_updates))
 
+    def components_full(self):
+        q = [self]
+        out = []
+        while len(q) > 0:
+            cur = q.pop()
+            if hasattr(cur, "components"):
+                q.extend(cur.components)
+            else:
+                out.append(cur)
+        out = list(set(out))
+        return out
+
 
 class ParallelBlock(Block):
     def __init__(self, data: Dict):

math_spec_mapping-0.2.5/src/Convenience/__init__.py

@@ -0,0 +1 @@
+from .documentation import write_top_level_json_description

math_spec_mapping-0.2.5/src/Convenience/documentation.py

@@ -0,0 +1,49 @@
+from src import schema
+
+
+def write_json_description(schema, key, name):
+    out = "- **{}**: ".format(name)
+
+    out += schema["definitions"][key]["description"]
+    out += "\n"
+    return out
+
+
+def write_top_level_json_description(indent_level):
+
+    out = "#{} MSML Components".format("#" * indent_level)
+    out += "\n\n"
+    out += "MSML extends GDS with multiple types of blocks and other enhancements. Below are the definitions of top level components."
+    out += "\n\n"
+
+    out += "##{} Types & Spaces".format("#" * indent_level)
+    out += "\n\n"
+
+    out += write_json_description(schema, "Type", "Type")
+    out += write_json_description(schema, "Space", "Space")
+
+    out += "\n"
+
+    out += "##{} Entities, States, Parameters & Metrics".format("#" * indent_level)
+    out += "\n\n"
+
+    out += write_json_description(schema, "Entity", "Entity")
+    out += write_json_description(schema, "State", "State")
+    out += write_json_description(schema, "StatefulMetric", "Stateful Metric")
+    out += write_json_description(schema, "Parameter", "Parameter")
+    out += write_json_description(schema, "Metric", "Metric")
+
+    out += "\n"
+
+    out += "##{} Blocks & Wiring".format("#" * indent_level)
+    out += "\n\n"
+
+    out += write_json_description(schema, "BoundaryAction", "Boundary Action")
+    out += write_json_description(schema, "ControlAction", "Control Action")
+    out += write_json_description(schema, "Policy", "Policy")
+    out += write_json_description(schema, "Mechanism", "Mechanism")
+    out += write_json_description(schema, "Wiring", "Wiring")
+
+    out += "\n"
+
+    return out

{math_spec_mapping-0.2.4 → math_spec_mapping-0.2.5}/src/Load/stateful_metrics.py

@@ -55,5 +55,9 @@ def load_stateful_metrics(ms: Dict, json: Dict) -> None:
     """
 
     ms["Stateful Metrics"] = {}
+    check = []
     for sm in json["Stateful Metrics"]:
         ms["Stateful Metrics"][sm["name"]] = convert_stateful_metric(ms, sm)
+        for x in ms["Stateful Metrics"][sm["name"]].metrics:
+            assert x.name not in check, "{} stateful metric name is repeated"
+            check.append(x)

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

@@ -37,6 +37,7 @@ def convert_type(data, ms):
                 data["type_name"]["python"] = data["type"]["python"].__repr__()
             else:
                 data["type_name"]["python"] = data["type"]["python"].__name__
+    if "typescript" in ms["Type Keys"]:
         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]

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

@@ -147,11 +147,18 @@ def write_spec_tree(
     out += symbol1 + "**Stateful Metrics**\n"
     for name in ms.stateful_metrics.keys():
         if linking:
-            out += symbol2 + "[[{}]]".format(name) + "\n"
+            out += symbol2 + "{}".format(name) + "\n"
         else:
             out += symbol2 + name + "\n"
         for var in ms.stateful_metrics[name].metrics:
-            out += symbol3 + var.name + "\n"
+            out += symbol3 + "[[{}]]".format(var.name) + "\n"
+
+    out += symbol1 + "**Types**\n"
+    for name in ms.types.keys():
+        if linking:
+            out += symbol2 + "[[{}]]".format(name) + "\n"
+        else:
+            out += symbol2 + name + "\n"
 
     out += symbol1 + "**Spaces**\n"
     for name in ms.spaces.keys():
@@ -162,11 +169,11 @@ def write_spec_tree(
     out += symbol1 + "**Parameters**\n"
     for name in ms.parameters.data.keys():
         if linking:
-            out += symbol2 + "[[{}]]".format(name) + "\n"
+            out += symbol2 + "{}".format(name) + "\n"
         else:
             out += symbol2 + name + "\n"
         for param in [x.name for x in ms.parameters.data[name].parameters]:
-            out += symbol3 + param + "\n"
+            out += symbol3 + "[[{}]]".format(param) + "\n"
 
     out += symbol1 + "**Boundary Actions**\n"
     for name in ms.boundary_actions.keys():

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

@@ -135,6 +135,12 @@ def write_boundary_action_markdown_report(ms, path, boundary_action, add_metadat
         out += "\n"
     out += "\n"
 
+    out += "## Followed By\n"
+    for i, x in enumerate([x[0] for x in boundary_action.calls]):
+        out += "{}. [[{}]]".format(i + 1, x.label)
+        out += "\n"
+    out += "\n"
+
     out += "## Constraints"
     for i, x in enumerate(boundary_action.constraints):
         out += "{}. {}".format(i + 1, x)
@@ -342,6 +348,12 @@ def write_control_action_markdown_report(ms, path, control_action, add_metadata=
     out += control_action.description
     out += "\n"
 
+    out += "## Followed By\n"
+    for i, x in enumerate([x[0] for x in control_action.calls]):
+        out += "{}. [[{}]]".format(i + 1, x.label)
+        out += "\n"
+    out += "\n"
+
     out += "## Constraints"
     for i, x in enumerate(control_action.constraints):
         out += "{}. {}".format(i + 1, x)
@@ -406,7 +418,14 @@ def write_wiring_markdown_report(ms, path, wiring, add_metadata=True):
 
     out += "\n"
 
-    out += "## Constraints"
+    out += "## All Blocks\n"
+    for i, x in enumerate(wiring.components_full()):
+        out += "{}. [[{}]]".format(i + 1, x.name)
+        out += "\n"
+
+    out += "\n"
+
+    out += "## Constraints\n"
     for i, x in enumerate(wiring.constraints):
         out += "{}. {}".format(i + 1, x)
         out += "\n"
@@ -510,7 +529,7 @@ def write_stateful_metrics_markdown_report(ms, path, metric, add_metadata=True):
 
     out += "## Variables Used\n"
     for i, x in enumerate(metric.variables_used):
-        out += "{}. {}.{}".format(i + 1, x[0], x[1])
+        out += "{}. [[{}]].{}".format(i + 1, x[0], x[1])
         out += "\n"
     out += "\n"
 
@@ -544,12 +563,18 @@ def write_metrics_markdown_report(ms, path, metric, add_metadata=True):
     out += "## Parameters Used\n"
     for i, x in enumerate(metric.parameters_used):
         out += "{}. [[{}]]".format(i + 1, x)
+        var = ms.parameters.parameter_map[x]
+        if var.symbol:
+            out += " , symbol: {}".format(var.symbol)
         out += "\n"
     out += "\n"
 
     out += "## Variables Used\n"
     for i, x in enumerate(metric.variables_used):
         out += "{}. {}.{}".format(i + 1, x[0], x[1])
+        var = ms.state[x[0]].variable_map[x[1]]
+        if var.symbol:
+            out += " , symbol: {}".format(var.symbol)
         out += "\n"
     out += "\n"
 
@@ -603,7 +628,7 @@ def write_wiring_display_markdown_report(ms, path, wiring, add_metadata=True):
     out += "\n"
 
     out += "## Unique Components Used\n"
-    components = [set(x.components) for x in wirings]
+    components = [set(x.components_full()) for x in wirings]
     components = set().union(*components)
     for i, x in enumerate(components):
         out += "{}. [[{}]]".format(i + 1, x.name)
@@ -638,7 +663,26 @@ def write_wiring_display_markdown_report(ms, path, wiring, add_metadata=True):
         f.write(out)
 
 
-def write_all_markdown_reports(ms, path):
+def write_all_markdown_reports(ms, path, clear_folders=False):
+    if clear_folders:
+        for x in [
+            "Metrics",
+            "Mechanisms",
+            "Types",
+            "Control Actions",
+            "Spaces",
+            ".obsidian",
+            "Boundary Actions",
+            "Policies",
+            "Wiring",
+            "States",
+            "Parameters",
+            "Entities",
+            "Stateful Metrics",
+        ]:
+            if os.path.exists("{}/{}".format(path, x)):
+                for y in os.listdir("{}/{}".format(path, x)):
+                    os.remove("{}/{}/{}".format(path, x, y))
 
     # Write entities
     entities = list(ms.entities.keys())

{math_spec_mapping-0.2.4 → math_spec_mapping-0.2.5}/src/__init__.py

@@ -26,3 +26,4 @@ from .Reports import (
     write_all_markdown_reports,
 )
 from .schema import schema
+from .Convenience import write_top_level_json_description

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: math_spec_mapping
-Version: 0.2.4
+Version: 0.2.5
 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.4 → math_spec_mapping-0.2.5}/src/math_spec_mapping.egg-info/SOURCES.txt

@@ -20,6 +20,7 @@ src/Classes/StatefulMetric.py
 src/Classes/Type.py
 src/Classes/__init__.py
 src/Convenience/__init__.py
+src/Convenience/documentation.py
 src/Convenience/starter.py
 src/Load/__init__.py
 src/Load/action_transmission_channel.py