math-spec-mapping 0.3.0__tar.gz → 0.3.2__tar.gz

{math-spec-mapping-0.3.0/src/math_spec_mapping.egg-info → math_spec_mapping-0.3.2}/PKG-INFO

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

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

{math-spec-mapping-0.3.0 → math_spec_mapping-0.3.2}/src/math_spec_mapping/Classes/MathSpec.py

@@ -6,6 +6,7 @@ from .ControlAction import ControlAction
 from .BoundaryAction import BoundaryAction
 import os
 from copy import deepcopy
+import shutil
 
 
 class MathSpec:
@@ -603,6 +604,45 @@ class MathSpec:
         with open(path, "w") as f:
             f.write(out)
 
+    def metaprogramming_julia_types(self, model_directory, overwrite=False):
+        path = model_directory + "/types.jl"
+        if not overwrite:
+            assert "types.jl" not in os.listdir(
+                model_directory
+            ), "The types file is already written, either delete it or switch to overwrite mode"
+
+        shutil.copyfile("src/TypeMappings/types.jl", path)
+
+    def metaprogramming_julia_spaces(
+        self, model_directory, cadCAD_path, overwrite=False
+    ):
+        path = model_directory + "/spaces.jl"
+        if not overwrite:
+            assert "spaces.jl" not in os.listdir(
+                model_directory
+            ), "The spaces file is already written, either delete it or switch to overwrite mode"
+
+        out = """include("{}")
+include("types.jl")
+using .Spaces: generate_space_type
+
+""".format(
+            cadCAD_path
+        )
+
+        for space in self.spaces:
+            name = self.spaces[space].name
+            schema = self.spaces[space].schema
+            schema = ["{}={}".format(x, schema[x].original_type_name) for x in schema]
+            if len(schema) >= 1:
+                schema = ", ".join(schema) + ","
+                out += 'generate_space_type(({}), "{}")'.format(schema, name)
+                out += "\n"
+            # out += "{} = Spaces.{}".format(name, name)
+
+        with open(path, "w") as f:
+            f.write(out)
+
     def build_implementation(self, params):
         return MathSpecImplementation(self, params)
 

{math-spec-mapping-0.3.0 → math_spec_mapping-0.3.2}/src/math_spec_mapping/Classes/State.py

@@ -45,6 +45,7 @@ class StateVariable:
         self.symbol = data["symbol"]
         self.domain = data["domain"]
         self.updated_by = []
+        self.metadata = data["metadata"]
 
         # Add check for type of List
         if hasattr(self.type, "_name"):

math_spec_mapping-0.3.2/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.0 → math_spec_mapping-0.3.2}/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.2/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.0 → math_spec_mapping-0.3.2}/src/math_spec_mapping/Load/metrics.py

@@ -100,5 +100,9 @@ def load_metrics(ms: Dict, json: Dict, stateful_metrics_map) -> None:
         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])
+            assert (
+                x in ms["Metrics"] or x in stateful_metrics_map
+            ), "{} not a valid metric or stateful metric".format(x)
+            policy.metrics_used.append(
+                ms["Metrics"][x] if x in ms["Metrics"] else stateful_metrics_map[x]
+            )

{math-spec-mapping-0.3.0 → math_spec_mapping-0.3.2}/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.0 → math_spec_mapping-0.3.2}/src/math_spec_mapping/Load/states.py

@@ -27,6 +27,8 @@ def convert_state(ms, data: Dict) -> State:
         check_json_keys(var, "State Variable")
         assert var["type"] in ms["Types"], "Type not in ms"
         var["type"] = ms["Types"][var["type"]]
+        if "metadata" not in var:
+            var["metadata"] = {}
         new_variables.append(StateVariable(var))
     data["variables"] = new_variables
 

{math-spec-mapping-0.3.0 → math_spec_mapping-0.3.2}/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:
@@ -111,6 +112,9 @@ def load_julia_type_key(path):
         elif x.startswith("struct"):
             name = name[7:]
             name = name[: name.index("\n")].strip()
+        if x.startswith("const"):
+            name = name[6:]
+            name = name[: name.index("=")].strip()
         else:
             assert False
 

{math-spec-mapping-0.3.0 → math_spec_mapping-0.3.2}/src/math_spec_mapping/Reports/html.py

@@ -152,7 +152,10 @@ cssclasses:
         else:
             out += symbol2 + name + "\n"
         for var in ms.state[name].variable_map.keys():
-            out += symbol3 + var + "\n"
+            if linking:
+                out += symbol3 + "[[{}-{}\|{}]]".format(name, var, var) + "\n"
+            else:
+                out += symbol3 + var + "\n"
 
     out += symbol1 + "**Stateful Metrics**\n"
     for name in ms.stateful_metrics.keys():

{math-spec-mapping-0.3.0 → math_spec_mapping-0.3.2}/src/math_spec_mapping/Reports/markdown.py

@@ -145,7 +145,7 @@ def write_boundary_action_markdown_report(ms, path, boundary_action, add_metadat
         out += "\n"
     out += "\n"
 
-    out += "## Constraints"
+    out += "## Constraints\n"
     for i, x in enumerate(boundary_action.constraints):
         out += "{}. {}".format(i + 1, x)
         out += "\n"
@@ -179,6 +179,8 @@ def write_policy_markdown_report(ms, path, policy, add_metadata=True):
     policy = ms.policies[policy]
     if "Policies" not in os.listdir(path):
         os.makedirs(path + "/Policies")
+
+    out = ""
     if add_metadata:
         metadata = policy.metadata
         if len(metadata) > 0:
@@ -188,7 +190,7 @@ def write_policy_markdown_report(ms, path, policy, add_metadata=True):
 """.format(
                 "\n".join(["{}: {}".format(x, metadata[x]) for x in metadata])
             )
-    out = ""
+
     out += "## Description"
     out += "\n"
     out += "\n"
@@ -292,7 +294,9 @@ def write_mechanism_markdown_report(ms, path, mechanism, add_metadata=True):
     out += "\n\n"
     out += "## Updates\n\n"
     for i, x in enumerate(mechanism.updates):
-        out += "{}. [[{}]].{}".format(i + 1, x[0].name, x[1].name)
+        out += "{}. [[{}]].[[{}|{}]]".format(
+            i + 1, x[0].name, x[0].state.name + "-" + x[1].name, x[1].name
+        )
         out += "\n"
 
     with open("{}/Mechanisms/{}.md".format(path, mechanism.label), "w") as f:
@@ -472,8 +476,14 @@ def write_wiring_markdown_report(ms, path, wiring, add_metadata=True):
     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 += "{}. [[{}]].[[{}|{}]]".format(
+            i + 1,
+            x[0].name,
+            ms.entities[x[0].name].state.name + "-" + x[1].name,
+            x[1].name,
+        )
         out += "\n"
     out += "\n"
 
@@ -575,7 +585,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)
@@ -608,6 +618,45 @@ def write_displays_markdown_reports(ms, path, add_metadata=True):
         )
 
 
+def write_state_variables_markdown_reports(ms, path, state, add_metadata=True):
+    if "State Variables" not in os.listdir(path):
+        os.makedirs(path + "/State Variables")
+    state = ms.state[state]
+    for variable in state.variables:
+        out = ""
+        if add_metadata:
+            metadata = variable.metadata
+            if len(metadata) > 0:
+                out += """---
+        {}
+---
+""".format(
+                    "\n".join(["{}: {}".format(x, metadata[x]) for x in metadata])
+                )
+        out += "Description: "
+        out += variable.description
+        out += "\n\n"
+        out += "Type: [["
+        out += variable.type.name
+        out += "]]\n\n"
+        out += "Symbol: "
+        if variable.symbol:
+            out += variable.symbol
+        out += "\n\n"
+        out += "Domain: "
+        if variable.domain:
+            out += variable.domain
+        out += "\n\n"
+
+        with open(
+            "{}/State Variables/{}.md".format(
+                path, "{}-{}".format(state.name, variable.name)
+            ),
+            "w",
+        ) as f:
+            f.write(out)
+
+
 def write_wiring_display_markdown_report(ms, path, wiring, add_metadata=True):
     wirings = [ms.wiring[w] for w in wiring["components"]]
     out = ""
@@ -696,6 +745,7 @@ def write_all_markdown_reports(ms, path, clear_folders=False):
     states = list(ms.state.keys())
     for x in states:
         write_state_markdown_report(ms, path, x)
+        write_state_variables_markdown_reports(ms, path, x)
 
     # Write types
     for t in ms.types.values():

{math-spec-mapping-0.3.0 → math_spec_mapping-0.3.2}/src/math_spec_mapping/Reports/state.py

@@ -51,6 +51,8 @@ def write_state_variable_table_markdown(target_state, links=False):
             if tv:
                 if links and i == 2:
                     table += "[[{}]]".format(tv)
+                elif links and i == 0:
+                    table += "[[{}-{}\|{}]]".format(target_state.name, tv, tv)
                 else:
                     table += "{}".format(tv)
             table += "|"

{math-spec-mapping-0.3.0 → math_spec_mapping-0.3.2}/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.0 → math_spec_mapping-0.3.2}/src/math_spec_mapping/schema.schema.json

@@ -360,7 +360,8 @@
                         "type": "string"
                     },
                     "description": "All metrics used in implementation of policies"
-                }
+                },
+                "metadata": {"type": "object"}
             },
             "required": [
                 "codomain",
@@ -390,7 +391,8 @@
                 "logic": {
                     "type": "string",
                     "description": "Any logic associated with the implementation"
-                }
+                },
+                "metadata": {"type": "object"}
             },
             "required": [
                 "description",
@@ -561,7 +563,8 @@
                 "domain": {
                     "type": ["string","null"],
                     "description": "The mathematical domain of the parameter (optional)"
-                }
+                },
+                "metadata": {"type": "object"}
             },
             "required": [
                 "description",
@@ -690,7 +693,8 @@
                     "items": {
                         "type": "integer"
                     }
-                }
+                },
+                "metadata": {"type": "object"}
             },
             "required": [
                 "components",

{math-spec-mapping-0.3.0 → math_spec_mapping-0.3.2/src/math_spec_mapping.egg-info}/PKG-INFO

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

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