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

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

Convenience/__init__.py

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

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

Load/implementations.py

@@ -0,0 +1,16 @@
+import os
+
+
+def load_implementations(ms):
+    implementations = {}
+    python_path = "src/Implementations/Python/__init__.py"
+    if os.path.exists(python_path):
+        implementations["python"] = load_python_implementations()
+
+    ms["Implementations"] = implementations
+
+
+def load_python_implementations():
+    from src.Implementations.Python import implementation
+
+    return implementation

Load/load.py

@@ -16,6 +16,7 @@ from .wiring import load_wiring
 from .type import load_types, load_type_keys
 from .metrics import load_metrics
 from .displays import load_displays
+from .implementations import load_implementations
 
 
 def load_from_json(json: Dict) -> MathSpec:
@@ -39,6 +40,7 @@ def load_from_json(json: Dict) -> MathSpec:
     # Do loading one by one to transfer the json
 
     load_type_keys(ms)
+    load_implementations(ms)
     load_types(ms, json)
     load_spaces(ms, json)
     load_states(ms, json)

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)

Load/type.py

@@ -37,9 +37,14 @@ 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]
+    if "julia" in ms["Type Keys"]:
+        if type_name in ms["Type Keys"]["julia"]:
+            data["type"]["julia"] = ms["Type Keys"]["julia"][type_name]
+            data["type_name"]["julia"] = ms["Type Keys"]["julia"][type_name]
 
     # Build the type object
     return Type(data)
@@ -88,13 +93,40 @@ def load_typescript_type_key(path):
     return type_definitions
 
 
-def load_type_keys(ms) -> dict:
+def load_julia_type_key(path):
+    with open(path, "r") as file:
+        type_definitions = file.read()
+    type_definitions = type_definitions.split("end")
+    type_definitions = [x.strip() for x in type_definitions]
+    type_definitions = [x for x in type_definitions if len(x) > 0]
+
+    hold = type_definitions[:]
+    type_definitions = {}
+    for x in hold:
+        name = x
+        if x.startswith("abstract type"):
+            name = name[14:]
+            name = name[: name.index("<:")].strip()
+        elif x.startswith("struct"):
+            name = name[7:]
+            name = name[: name.index("\n")].strip()
+        else:
+            assert False
+
+        type_definitions[name] = x
+    return type_definitions
+
+
+def load_type_keys(ms):
     type_keys = {}
     python_path = "src/TypeMappings/types.py"
     typescript_path = "src/TypeMappings/types.ts"
+    julia_path = "src/TypeMappings/types.jl"
     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)
+    if os.path.exists(julia_path):
+        type_keys["julia"] = load_julia_type_key(julia_path)
 
     ms["Type Keys"] = type_keys

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():

Reports/markdown.py

@@ -99,6 +99,10 @@ def write_types_markdown_report(ms, path, t, add_metadata=True):
         out += "### Typescript Type\n"
         out += t.type_name["typescript"]
         out += "\n"
+    if "julia" in t.type:
+        out += "### Julia Type\n"
+        out += t.type_name["julia"]
+        out += "\n"
     out += "\n"
     out += "## Notes"
     out += "\n\n"
@@ -135,6 +139,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 +352,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 +422,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 +533,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 +567,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 +632,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 +667,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.dist-info → math_spec_mapping-0.2.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: math_spec_mapping
-Version: 0.2.4
+Version: 0.2.6
 Summary: A library for easy mapping of mathematical specifications.
 Author-email: Sean McOwen <Sean@Block.Science>
 Classifier: Programming Language :: Python :: 3
@@ -23,6 +23,10 @@ It uses block diagram wirings and spaces to represent the actions in complex sys
 
 One good example is the [wiring report](https://github.com/SeanMcOwen/Root-Finding-Simulation/blob/main/MSML/reports/Simulation%20Block.md) for the Root Finding Simulation canonical example.
 
+## Installing the library
+
+To install the library, simply pip install by running "pip install math_spec_mapping"
+
 ## Why MSML?
 
 Writing mathematical specifications can be a difficult process, especially when variable names are changed or new mechanisms are introduced. MSML seeks to streamline the process with automations as well as enhance the abilities of static math specs to deliver deeper insights. Because it is automated, one can write specifications at different levels of details or for different purposes.

{math_spec_mapping-0.2.4.dist-info → math_spec_mapping-0.2.6.dist-info}/RECORD

@@ -1,7 +1,5 @@
-__init__.py,sha256=bWYy9HVSz89bN8y7H7fP7Xrd1TLliPp73zWBUe3KuFE,846
-schema.py,sha256=6mrRqzEnTTSXjb19xJ63MBp0KjKH0s7i6TfT4MkAY9k,233
 Classes/ActionTransmissionChannel.py,sha256=zWMo5QsgPh5WGIWXl-xOrZNMXYJXmK6Vejw1dQvi0og,246
-Classes/Block.py,sha256=HUM_ziEE40DBy_mG-XFnHjg3MTTO2C5e6ONyZIAy77Q,17000
+Classes/Block.py,sha256=hXQO221IP-TqZm_TwFKfURpEEjZm7L1TPZDCYlaOdho,17302
 Classes/BoundaryAction.py,sha256=AOENCqCEfpjotnHhzUj_F2SOP0SGpkN1tNPr8Mtl6Tc,476
 Classes/ControlAction.py,sha256=xaU3_WVeWOoOFX3O86x30_9Eiirfe76KrO3M2kfjcmo,471
 Classes/Entity.py,sha256=fA0-b128_OHHxfCg4pzqyQV083EYev1HlVpy86S5igg,1226
@@ -16,7 +14,8 @@ Classes/StateUpdateTransmissionChannel.py,sha256=3hBLvD1lE64PkwqksBXAfFWv7foOZzG
 Classes/StatefulMetric.py,sha256=UCis1BJ7fsajHHxFF05ZiyDean2D4s4a95uYYW1Mjq4,749
 Classes/Type.py,sha256=ZDHSiaDixHOxasOJlHbuBsMjZ29O2O5K_nmHOmlO-Ck,228
 Classes/__init__.py,sha256=_hXyZMJanmIex_W6yCR2H7Jw8iU2JJIf3U7VcvBSOGU,737
-Convenience/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+Convenience/__init__.py,sha256=-hNZVoaNSgTmZTiyZoMfWyg14xonC3ppz-diQk1VlUY,60
+Convenience/documentation.py,sha256=Jf7-JJIk_vZkNBIGV4bs5LM3B0RVaCCtuwJ164thGfY,1607
 Convenience/starter.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 Load/__init__.py,sha256=_ga5nHi7U5rY5lCF36_XI9Qmybq4P8R4m5I5mmjLBk8,33
 Load/action_transmission_channel.py,sha256=9Wer7g2s5SSOcUYuZ0PqSKUVVnW3EvGQJZNXJTwW__0,2561
@@ -25,23 +24,24 @@ 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=VEiZRsiO3QQnw5ZIJ0RQzgQ5hKoWLz6b36Zv9tG-XvI,2405
+Load/implementations.py,sha256=SGKZ_YXeNpJUTnw5fajQTXji7S2bNQo8sh-7YcIO6pk,395
+Load/load.py,sha256=CLprDhJpbwm9RAzKM2Ghwr8eqBu0a-wvGDOCMmc01YE,2484
 Load/mechanism.py,sha256=aIpMzgQn8f1aywgOHxL5kHQUn1N8K9pmHOVs51bv3Hk,1673
 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/stateful_metrics.py,sha256=uGSTc6x6lld5xptgSUMHrO0Vg0QDRIL14C6zTg33S8o,1977
 Load/states.py,sha256=cwo29SBAtj1FoQLEb8c0wkSCn038lIgM9RjNiZefUaE,1223
-Load/type.py,sha256=cKfeLAmYG4hl4mxYA3FvWoQt16ReWrL64H98wgehp6U,3043
+Load/type.py,sha256=R6d5t55TMMCKsOk8xXp_Cu5gvkt2DG4Yzvq6NREIefs,4174
 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=4wpry61_URAc_LeVemQWowVWGlhMwayjaS3eyUSm0rM,7866
-Reports/markdown.py,sha256=j5QYmk9HXZK9mL3LQqJaW7FJ9oqCmBpEfmvtElljiso,19643
+Reports/html.py,sha256=rBnwvWeFgCfP7O8nsBL6hWE63Y1Qd24QyGD2Z7CnZ-8,8094
+Reports/markdown.py,sha256=pDGHYMdtZmeXHqvU9FB3BycyB4qflWXq0bf2m-wsXMU,21138
 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.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,,
+math_spec_mapping-0.2.6.dist-info/LICENSE,sha256=ObyEzSw8kgCaFbEfpu1zP4TrcAKLA0xhqHMZZfyh7N0,1069
+math_spec_mapping-0.2.6.dist-info/METADATA,sha256=1v4DFrmGZm4H3SbrpBO9BM55KgJVnWGqVtHnEoy3zjQ,6012
+math_spec_mapping-0.2.6.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+math_spec_mapping-0.2.6.dist-info/top_level.txt,sha256=Su_elDptuaN90UL6S2mN2Tb7kpAL6HuAZiLrbNPwBdc,33
+math_spec_mapping-0.2.6.dist-info/RECORD,,

{math_spec_mapping-0.2.4.dist-info → math_spec_mapping-0.2.6.dist-info}/top_level.txt

@@ -2,5 +2,3 @@ Classes
 Convenience
 Load
 Reports
-__init__
-schema

__init__.py

@@ -1,28 +0,0 @@
-from .Load import load_from_json
-from .Reports import (
-    create_action_chains_graph,
-    write_out_boundary_actions,
-    write_out_policies,
-    write_out_mechanisms,
-    load_svg_graphviz,
-    write_basic_report_full,
-    write_action_chain_reports,
-    write_spec_tree,
-    create_parameter_impact_table,
-    write_entity_reports,
-    write_wiring_report,
-    write_overview,
-    write_entity_markdown_report,
-    write_state_markdown_report,
-    write_types_markdown_report,
-    write_boundary_action_markdown_report,
-    write_policy_markdown_report,
-    write_mechanism_markdown_report,
-    write_space_markdown_report,
-    write_control_action_markdown_report,
-    write_wiring_markdown_report,
-    write_parameter_markdown_report,
-    write_stateful_metrics_markdown_report,
-    write_all_markdown_reports,
-)
-from .schema import schema

schema.py

@@ -1,8 +0,0 @@
-import pathlib
-import json
-
-current_path = pathlib.Path(__file__).parent.resolve()
-with open("{}/schema.schema.json".format(current_path), "r") as f:
-    f = f.read()
-f = f.replace("./schema.schema.json/", "")
-schema = json.loads(f)