math-spec-mapping 0.3.1__tar.gz → 0.3.3__tar.gz

{math_spec_mapping-0.3.1/src/math_spec_mapping.egg-info → math_spec_mapping-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: math-spec-mapping
-Version: 0.3.1
+Version: 0.3.3
 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.3.1 → math_spec_mapping-0.3.3}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools>=61.0"]
 build-backend = "setuptools.build_meta"
 [project]
 name = "math-spec-mapping"
-version = "0.3.1"
+version = "0.3.3"
 authors = [
   { name="Sean McOwen", email="Sean@Block.Science" },
 ]

{math_spec_mapping-0.3.1 → math_spec_mapping-0.3.3}/src/math_spec_mapping/Classes/Block.py

@@ -83,6 +83,7 @@ class Block:
             updates = self.all_updates
         else:
             return "\n", {}
+        updates = sorted(updates, key=lambda x: x[0].name + "-" + x[1].name)
 
         out = "\n"
         out += 'subgraph SVS["State Variables"]\n'
@@ -90,6 +91,7 @@ class Block:
         # Render the entities
         entity_mapping = {}
         entities = set([x[0] for x in updates])
+        entities = sorted(entities, key=lambda x: x.name)
         for i, x in enumerate(entities):
             entity_mapping[x.name] = "EE{}".format(i)
             out += '{}[("{}")]'.format(entity_mapping[x.name], x.name)

{math_spec_mapping-0.3.1 → math_spec_mapping-0.3.3}/src/math_spec_mapping/Classes/State.py

@@ -31,7 +31,9 @@ class State:
             # Check variable name not repeated
             assert (
                 var.name not in self.variable_map
-            ), "Variable name {} is already present in variables!".format(key)
+            ), "Variable name {} is already present in variables for the state of {}!".format(
+                key, self.name
+            )
 
             self.variable_map[key] = var
 

math_spec_mapping-0.3.3/src/math_spec_mapping/Convenience/__init__.py

@@ -0,0 +1,2 @@
+# from .documentation import write_top_level_json_description
+from .starter import remove_dummy_repo_components

{math_spec_mapping-0.3.1 → math_spec_mapping-0.3.3}/src/math_spec_mapping/Convenience/documentation.py

@@ -1,4 +1,4 @@
-from src import schema
+from src.math_spec_mapping import schema
 
 
 def write_json_description(schema, key, name):

math_spec_mapping-0.3.3/src/math_spec_mapping/Convenience/starter.py

@@ -0,0 +1,271 @@
+import os
+
+
+def remove_dummy_repo_components(path):
+
+    directory_folders = os.listdir(path)
+
+    if "StatefulMetrics" in directory_folders:
+        path2 = path + "/StatefulMetrics"
+        contents = os.listdir(path2)
+        if "Dummy.py" in contents:
+            os.remove(path2 + "/Dummy.py")
+        if "__init__.py" in contents:
+            with open(path2 + "/__init__.py", "r") as f:
+                contents = f.read()
+                contents = contents.replace(
+                    "from .Dummy import dummy_stateful_metrics\n", ""
+                )
+                contents = contents.replace(
+                    "stateful_metrics.extend(dummy_stateful_metrics)\n", ""
+                )
+                contents = contents.replace(
+                    "stateful_metrics.extend(dummy_stateful_metrics)", ""
+                )
+            with open(path2 + "/__init__.py", "w") as f:
+                f.write(contents)
+
+    if "Metrics" in directory_folders:
+        path2 = path + "/Metrics"
+        contents = os.listdir(path2)
+        if "Dummy.py" in contents:
+            os.remove(path2 + "/Dummy.py")
+        if "__init__.py" in contents:
+            with open(path2 + "/__init__.py", "r") as f:
+                contents = f.read()
+                contents = contents.replace("from .Dummy import metrics_x\n", "")
+                contents = contents.replace("metrics.extend(metrics_x)\n", "")
+                contents = contents.replace("metrics.extend(metrics_x)", "")
+            with open(path2 + "/__init__.py", "w") as f:
+                f.write(contents)
+
+    """if "Displays" in directory_folders:
+        path2 = path + "/Displays"
+        contents = os.listdir(path2)
+        if "Dummy.py" in contents:
+            os.remove(path2 + "/Dummy.py")
+        if "__init__.py" in contents:
+            with open(path2 + "/__init__.py", "r") as f:
+                contents = f.read()
+                contents = contents.replace("from .Dummy import metrics_x\n", "")
+                contents = contents.replace("metrics.extend(metrics_x)\n", "")
+                contents = contents.replace("metrics.extend(metrics_x)", "")
+            with open(path2 + "/__init__.py", "w") as f:
+                f.write(contents)"""
+
+    if "Wiring" in directory_folders:
+        path2 = path + "/Wiring"
+        contents = os.listdir(path2)
+        if "Dummy.py" in contents:
+            os.remove(path2 + "/Dummy.py")
+        if "__init__.py" in contents:
+            with open(path2 + "/__init__.py", "r") as f:
+                contents = f.read()
+                contents = contents.replace("from .Dummy import dummy_wiring\n", "")
+                contents = contents.replace("wiring.extend(dummy_wiring)\n", "")
+                contents = contents.replace("wiring.extend(dummy_wiring)", "")
+            with open(path2 + "/__init__.py", "w") as f:
+                f.write(contents)
+
+    if "Mechanisms" in directory_folders:
+        path2 = path + "/Mechanisms"
+        contents = os.listdir(path2)
+        if "Dummy.py" in contents:
+            os.remove(path2 + "/Dummy.py")
+        if "__init__.py" in contents:
+            with open(path2 + "/__init__.py", "r") as f:
+                contents = f.read()
+                contents = contents.replace("from .Dummy import dummy_mechanisms\n", "")
+                contents = contents.replace("mechanism.extend(dummy_mechanisms)\n", "")
+                contents = contents.replace("mechanism.extend(dummy_mechanisms)", "")
+            with open(path2 + "/__init__.py", "w") as f:
+                f.write(contents)
+
+    if "Policies" in directory_folders:
+        path2 = path + "/Policies"
+        contents = os.listdir(path2)
+        if "Dummy.py" in contents:
+            os.remove(path2 + "/Dummy.py")
+        if "__init__.py" in contents:
+            with open(path2 + "/__init__.py", "r") as f:
+                contents = f.read()
+                contents = contents.replace("from .Dummy import dummy_policies\n", "")
+                contents = contents.replace("policies.extend(dummy_policies)\n", "")
+                contents = contents.replace("policies.extend(dummy_policies)", "")
+            with open(path2 + "/__init__.py", "w") as f:
+                f.write(contents)
+
+    if "BoundaryActions" in directory_folders:
+        path2 = path + "/BoundaryActions"
+        contents = os.listdir(path2)
+        if "Dummy.py" in contents:
+            os.remove(path2 + "/Dummy.py")
+        if "__init__.py" in contents:
+            with open(path2 + "/__init__.py", "r") as f:
+                contents = f.read()
+                contents = contents.replace(
+                    "from .Dummy import dummy_boundary_action\n", ""
+                )
+                contents = contents.replace("dummy_boundary_action,\n", "")
+                contents = contents.replace("dummy_boundary_action,", "")
+                contents = contents.replace("dummy_boundary_action", "")
+            with open(path2 + "/__init__.py", "w") as f:
+                f.write(contents)
+
+    if "ControlActions" in directory_folders:
+        path2 = path + "/ControlActions"
+        contents = os.listdir(path2)
+        if "Dummy.py" in contents:
+            os.remove(path2 + "/Dummy.py")
+        if "__init__.py" in contents:
+            with open(path2 + "/__init__.py", "r") as f:
+                contents = f.read()
+                contents = contents.replace(
+                    "from .Dummy import dummy_control_action\n", ""
+                )
+                contents = contents.replace("dummy_control_action,\n", "")
+                contents = contents.replace("dummy_control_action,", "")
+                contents = contents.replace("dummy_control_action", "")
+            with open(path2 + "/__init__.py", "w") as f:
+                f.write(contents)
+    if "Entities" in directory_folders:
+        path2 = path + "/Entities"
+        contents = os.listdir(path2)
+        if "Dummy.py" in contents:
+            os.remove(path2 + "/Dummy.py")
+        if "__init__.py" in contents:
+            with open(path2 + "/__init__.py", "r") as f:
+                contents = f.read()
+                contents = contents.replace("from .Dummy import dummy_entity\n", "")
+                contents = contents.replace("dummy_entity, ", "")
+                contents = contents.replace("dummy_entity,", "")
+                contents = contents.replace("dummy_entity", "")
+            with open(path2 + "/__init__.py", "w") as f:
+                f.write(contents)
+    if "State" in directory_folders:
+        path2 = path + "/State"
+        contents = os.listdir(path2)
+        if "Dummy.py" in contents:
+            os.remove(path2 + "/Dummy.py")
+        if "__init__.py" in contents:
+            with open(path2 + "/__init__.py", "r") as f:
+                contents = f.read()
+                contents = contents.replace("from .Dummy import dummy_state\n", "")
+                contents = contents.replace("dummy_state, ", "")
+                contents = contents.replace("dummy_state,", "")
+                contents = contents.replace("dummy_state", "")
+            with open(path2 + "/__init__.py", "w") as f:
+                f.write(contents)
+
+    if "Parameters" in directory_folders:
+        path2 = path + "/Parameters"
+        contents = os.listdir(path2)
+        if "Dummy.py" in contents:
+            os.remove(path2 + "/Dummy.py")
+        if "__init__.py" in contents:
+            with open(path2 + "/__init__.py", "r") as f:
+                contents = f.read()
+                contents = contents.replace(
+                    "from .Dummy import dummy_parameter_sets", ""
+                )
+                contents = contents.replace(
+                    "parameters.extend(dummy_parameter_sets)", ""
+                )
+
+            with open(path2 + "/__init__.py", "w") as f:
+                f.write(contents)
+
+    if "Spaces" in directory_folders:
+        path2 = path + "/Spaces"
+        contents = os.listdir(path2)
+        if "Dummy.py" in contents:
+            os.remove(path2 + "/Dummy.py")
+        if "__init__.py" in contents:
+            with open(path2 + "/__init__.py", "r") as f:
+                contents = f.read()
+                contents = contents.replace("from .Dummy import dummy_spaces\n", "")
+                contents = contents.replace("spaces.extend(dummy_spaces)", "")
+
+            with open(path2 + "/__init__.py", "w") as f:
+                f.write(contents)
+
+    if "Types" in directory_folders:
+        path2 = path + "/Types"
+        contents = os.listdir(path2)
+        if "Dummy.py" in contents:
+            os.remove(path2 + "/Dummy.py")
+        if "__init__.py" in contents:
+            with open(path2 + "/__init__.py", "r") as f:
+                contents = f.read()
+                contents = contents.replace(
+                    "from .Dummy import DummyCompoundType, DummyType1, DummyType2\n", ""
+                )
+                contents = contents.replace(
+                    """    DummyType1,
+    DummyType2,
+    DummyCompoundType,""",
+                    "",
+                )
+                contents = contents.replace(
+                    """    DummyType1,
+    DummyType2,
+    DummyCompoundType""",
+                    "",
+                )
+
+            with open(path2 + "/__init__.py", "w") as f:
+                f.write(contents)
+
+    if "TypeMappings" in directory_folders:
+        path2 = path + "/TypeMappings"
+        contents = os.listdir(path2)
+
+        if "types.py" in contents:
+            with open(path2 + "/types.py", "r") as f:
+                contents = f.read()
+                contents = contents.replace(
+                    """    "DummyType1": str,
+    "DummyType2": int,
+    "DummyCompoundType": {"A": "Dummy Type 1", "B": "Dummy Type 2"},""",
+                    "",
+                )
+
+            with open(path2 + "/types.py", "w") as f:
+                f.write(contents)
+
+    if "TypeMappings" in directory_folders:
+        path2 = path + "/TypeMappings"
+        contents = os.listdir(path2)
+
+        if "types.py" in contents:
+            with open(path2 + "/types.jl", "r") as f:
+                contents = f.read()
+                contents = contents.replace(
+                    """const DummyType1 = String
+const DummyType2 = Integer
+struct DummyCompoundType
+    A::DummyType1
+    B::DummyType2
+end""",
+                    "",
+                )
+
+            with open(path2 + "/types.jl", "w") as f:
+                f.write(contents)
+
+    if "TypeMappings" in directory_folders:
+        path2 = path + "/TypeMappings"
+        contents = os.listdir(path2)
+
+        if "types.py" in contents:
+            with open(path2 + "/types.ts", "r") as f:
+                contents = f.read()
+                contents = contents.replace(
+                    """type DummyType1 = string
+type DummyType2 = number
+type DummyCompoundType = {"A": DummyType1, "B": DummyType2}""",
+                    "",
+                )
+
+            with open(path2 + "/types.ts", "w") as f:
+                f.write(contents)

{math_spec_mapping-0.3.1 → math_spec_mapping-0.3.3}/src/math_spec_mapping/Load/boundary_actions.py

@@ -42,7 +42,9 @@ def convert_boundary_action(data: Dict, ms: Dict) -> BoundaryAction:
         for name in data["called_by"]:
             assert (
                 name in ms["Entities"]
-            ), "{} entity not in entities dictionary".format(name)
+            ), "{} entity not in entities dictionary which is referenced in called_by for {}".format(
+                name, data["name"]
+            )
         data["called_by"] = [ms["Entities"][x] for x in data["called_by"]]
 
     data["codomain"] = tuple(ms["Spaces"][x] for x in data["codomain"])

{math_spec_mapping-0.3.1 → math_spec_mapping-0.3.3}/src/math_spec_mapping/Load/entities.py

@@ -25,7 +25,11 @@ def convert_entity(data: Dict, ms: Dict) -> Entity:
     # Assert that the state is in the math spec and assign it here
     if data["state"]:
         name = data["state"]
-        assert name in ms["State"], "{} state not in states dictionary".format(name)
+        assert (
+            name in ms["State"]
+        ), "{} state not in states dictionary for the entity of {}".format(
+            name, data["name"]
+        )
         data["state"] = ms["State"][name]
 
     # Build the state object

{math_spec_mapping-0.3.1 → math_spec_mapping-0.3.3}/src/math_spec_mapping/Load/parameters.py

@@ -18,7 +18,9 @@ def convert_parameter_set(ms, data: Dict) -> ParameterSet:
         if "metadata" not in param:
             param["metadata"] = {}
         check_json_keys(param, "Parameter")
-        assert param["variable_type"] in ms["Types"], "Type not in ms"
+        assert param["variable_type"] in ms["Types"], "Type of {} not in ms".format(
+            param["variable_type"]
+        )
         param["variable_type"] = ms["Types"][param["variable_type"]]
         new_parameters.append(Parameter(param))
     data["parameters"] = new_parameters

{math_spec_mapping-0.3.1 → math_spec_mapping-0.3.3}/src/math_spec_mapping/Load/states.py

@@ -25,7 +25,7 @@ def convert_state(ms, data: Dict) -> State:
     new_variables = []
     for var in data["variables"]:
         check_json_keys(var, "State Variable")
-        assert var["type"] in ms["Types"], "Type not in ms"
+        assert var["type"] in ms["Types"], "Type {} not in ms".format(var["name"])
         var["type"] = ms["Types"][var["type"]]
         if "metadata" not in var:
             var["metadata"] = {}

{math_spec_mapping-0.3.1 → math_spec_mapping-0.3.3}/src/math_spec_mapping/Load/type.py

@@ -71,7 +71,8 @@ def load_typescript_type_key(path):
     type_definitions = [x for x in type_definitions if len(x) > 0]
     hold = type_definitions[:]
     type_definitions = []
-    type_definitions.append(hold.pop(0))
+    if len(hold) > 0:
+        type_definitions.append(hold.pop(0))
     while len(hold) > 0:
         curr = hold.pop(0)
         if "type" in curr or "interface" in curr:

{math_spec_mapping-0.3.1 → math_spec_mapping-0.3.3}/src/math_spec_mapping/Reports/markdown.py

@@ -225,7 +225,7 @@ def write_policy_markdown_report(ms, path, policy, add_metadata=True):
         out += "\n"
 
     out += "## Parameters Used\n"
-    for i, x in enumerate(policy.parameters_used):
+    for i, x in enumerate(sorted(policy.parameters_used, key=lambda x: x)):
         out += "{}. [[{}]]".format(i + 1, x)
         out += "\n"
 
@@ -427,7 +427,7 @@ def write_wiring_markdown_report(ms, path, wiring, add_metadata=True):
     out += "\n"
 
     out += "## All Blocks\n"
-    for i, x in enumerate(wiring.components_full()):
+    for i, x in enumerate(sorted(wiring.components_full(), key=lambda x: x.name)):
         out += "{}. [[{}]]".format(i + 1, x.name)
         out += "\n"
 
@@ -452,13 +452,13 @@ def write_wiring_markdown_report(ms, path, wiring, add_metadata=True):
     out += "\n"
 
     out += "## All Spaces Used\n"
-    for i, x in enumerate(wiring.all_spaces_used):
+    for i, x in enumerate(sorted(wiring.all_spaces_used, key=lambda x: x.name)):
         out += "{}. [[{}]]".format(i + 1, x.name)
         out += "\n"
     out += "\n"
 
     out += "## Parameters Used\n"
-    for i, x in enumerate(wiring.parameters_used):
+    for i, x in enumerate(sorted(wiring.parameters_used, key=lambda x: x)):
         out += "{}. [[{}]]".format(i + 1, x)
         out += "\n"
     out += "\n"
@@ -477,7 +477,9 @@ def write_wiring_markdown_report(ms, path, wiring, add_metadata=True):
 
     out += "## All State Updates\n"
 
-    for i, x in enumerate(wiring.all_updates):
+    for i, x in enumerate(
+        sorted(wiring.all_updates, key=lambda x: x[0].name + "-" + x[1].name)
+    ):
         out += "{}. [[{}]].[[{}|{}]]".format(
             i + 1,
             x[0].name,
@@ -536,7 +538,7 @@ def write_stateful_metrics_markdown_report(ms, path, metric, add_metadata=True):
     out += "Domain: {}\n\n".format(metric.domain)
 
     out += "## Parameters Used\n"
-    for i, x in enumerate(metric.parameters_used):
+    for i, x in enumerate(sorted(metric.parameters_used, key=lambda x: x.name)):
         out += "{}. [[{}]]".format(i + 1, x)
         out += "\n"
     out += "\n"
@@ -575,7 +577,7 @@ def write_metrics_markdown_report(ms, path, metric, add_metadata=True):
     out += "\n\n"
 
     out += "## Parameters Used\n"
-    for i, x in enumerate(metric.parameters_used):
+    for i, x in enumerate(sorted(metric.parameters_used, key=lambda x: x.name)):
         out += "{}. [[{}]]".format(i + 1, x)
         var = ms.parameters.parameter_map[x]
         if var.symbol:
@@ -585,7 +587,7 @@ def write_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[0], x[1], x[1])
         var = ms.state[x[0]].variable_map[x[1]]
         if var.symbol:
             out += " , symbol: {}".format(var.symbol)
@@ -683,6 +685,7 @@ def write_wiring_display_markdown_report(ms, path, wiring, add_metadata=True):
     out += "## Unique Components Used\n"
     components = [set(x.components_full()) for x in wirings]
     components = set().union(*components)
+    components = sorted(components, key=lambda x: x.name)
     for i, x in enumerate(components):
         out += "{}. [[{}]]".format(i + 1, x.name)
         out += "\n"
@@ -706,8 +709,9 @@ def write_wiring_display_markdown_report(ms, path, wiring, add_metadata=True):
 
     parameters = [set(x.parameters_used) for x in wirings]
     parameters = set().union(*parameters)
+    parameters = sorted(parameters, key=lambda x: x)
     out += "## Unique Parameters Used\n"
-    for i, x in enumerate(parameters):
+    for i, x in enumerate(sorted(parameters, key=lambda x: x.name)):
         out += "{}. [[{}]]".format(i + 1, x)
         out += "\n"
     out += "\n"

{math_spec_mapping-0.3.1 → math_spec_mapping-0.3.3}/src/math_spec_mapping/__init__.py

@@ -26,5 +26,6 @@ from .Reports import (
     write_all_markdown_reports,
 )
 from .schema import schema
+from .Convenience import remove_dummy_repo_components
 
 # from .Convenience import write_top_level_json_description

{math_spec_mapping-0.3.1 → math_spec_mapping-0.3.3}/src/math_spec_mapping/schema.schema.json

@@ -693,7 +693,8 @@
                     "items": {
                         "type": "integer"
                     }
-                }
+                },
+                "metadata": {"type": "object"}
             },
             "required": [
                 "components",

{math_spec_mapping-0.3.1 → math_spec_mapping-0.3.3/src/math_spec_mapping.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: math-spec-mapping
-Version: 0.3.1
+Version: 0.3.3
 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.3.1/src/math_spec_mapping/Convenience/__init__.py

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