math-spec-mapping 0.3.7__py3-none-any.whl → 0.3.9__py3-none-any.whl

math_spec_mapping/Classes/MathSpec.py

@@ -477,17 +477,23 @@ class MathSpec:
         state_base,
         post_processing_function,
         state_preperation_functions=None,
+        parameter_preperation_functions=None,
         metrics_functions=None,
     ):
         if experiment["Param Modifications"]:
             params_base = deepcopy(params_base)
             for key in experiment["Param Modifications"]:
                 params_base[key] = experiment["Param Modifications"][key]
+        if experiment["State Modifications"]:
+            state_base = deepcopy(state_base)
+            for key in experiment["State Modifications"]:
+                state_base[key] = experiment["State Modifications"][key]
         msi = self.build_implementation(params_base)
         state, params = msi.prepare_state_and_params(
             state_base,
             params_base,
             state_preperation_functions=state_preperation_functions,
+            parameter_preperation_functions=parameter_preperation_functions,
         )
 
         state = msi.execute_blocks(state, params, experiment["Blocks"])
@@ -510,6 +516,7 @@ class MathSpec:
         state_base,
         post_processing_function,
         state_preperation_functions=None,
+        parameter_preperation_functions=None,
         metrics_functions=None,
     ):
         state_l = []
@@ -524,6 +531,7 @@ class MathSpec:
                     state_base,
                     post_processing_function,
                     state_preperation_functions=state_preperation_functions,
+                    parameter_preperation_functions=parameter_preperation_functions,
                     metrics_functions=metrics_functions,
                 )
                 df["Monte Carlo Run"] = i + 1
@@ -1007,7 +1015,13 @@ class MathSpecImplementation:
             len(shouldnt_be_in_params) == 0
         ), "The following parameters are extra: {}".format(shouldnt_be_in_params)
 
-    def prepare_state_and_params(self, state, params, state_preperation_functions=None):
+    def prepare_state_and_params(
+        self,
+        state,
+        params,
+        state_preperation_functions=None,
+        parameter_preperation_functions=None,
+    ):
         self.validate_state_and_params(state, params)
         state = deepcopy(state)
         params = deepcopy(params)
@@ -1018,6 +1032,12 @@ class MathSpecImplementation:
                 assert (
                     state is not None
                 ), "A state must be returned from the state preperation functions"
+        if parameter_preperation_functions:
+            for f in parameter_preperation_functions:
+                params = f(params)
+                assert (
+                    params is not None
+                ), "A parameter set must be returned from the parameter preperation functions"
         return state, params
 
     def load_components(self):

math_spec_mapping/Convenience/starter.py

@@ -39,19 +39,27 @@ def remove_dummy_repo_components(path):
             with open(path2 + "/__init__.py", "w") as f:
                 f.write(contents)
 
-    """if "Displays" in directory_folders:
+    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:
+        if "wiring.py" in contents:
+            with open(path2 + "/wiring.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)"""
+
+                contents = contents.replace('"Dummy Boundary Wiring 2",\n', "")
+                contents = contents.replace('"Dummy Boundary Wiring 2",', "")
+                contents = contents.replace('"Dummy Boundary Wiring 2"', "")
+
+                contents = contents.replace('"Dummy Boundary Wiring",\n', "")
+                contents = contents.replace('"Dummy Boundary Wiring",', "")
+                contents = contents.replace('"Dummy Boundary Wiring"', "")
+
+                contents = contents.replace('"Dummy Control Wiring",\n', "")
+                contents = contents.replace('"Dummy Control Wiring",', "")
+                contents = contents.replace('"Dummy Control Wiring"', "")
+
+            with open(path2 + "/wiring.py", "w") as f:
+                f.write(contents)
 
     if "Wiring" in directory_folders:
         path2 = path + "/Wiring"
@@ -78,6 +86,8 @@ def remove_dummy_repo_components(path):
                 contents = contents.replace("from .Dummy import dummy_mechanisms\n", "")
                 contents = contents.replace("mechanism.extend(dummy_mechanisms)\n", "")
                 contents = contents.replace("mechanism.extend(dummy_mechanisms)", "")
+                contents = contents.replace("mechanisms.extend(dummy_mechanisms)\n", "")
+                contents = contents.replace("mechanisms.extend(dummy_mechanisms)", "")
             with open(path2 + "/__init__.py", "w") as f:
                 f.write(contents)
 
@@ -104,8 +114,23 @@ def remove_dummy_repo_components(path):
             with open(path2 + "/__init__.py", "r") as f:
                 contents = f.read()
                 contents = contents.replace(
-                    "from .Dummy import dummy_boundary_action\n", ""
+                    "from .Dummy import dummy_boundary_action, dummy_boundary_action2\n",
+                    "",
+                )
+                contents = contents.replace(
+                    "from .Dummy import dummy_boundary_actions\n",
+                    "",
+                )
+
+                contents = contents.replace(
+                    "boundary_actions.extend(dummy_boundary_actions)",
+                    "",
                 )
+
+                contents = contents.replace("dummy_boundary_action2,\n", "")
+                contents = contents.replace("dummy_boundary_action2,", "")
+                contents = contents.replace("dummy_boundary_action2", "")
+
                 contents = contents.replace("dummy_boundary_action,\n", "")
                 contents = contents.replace("dummy_boundary_action,", "")
                 contents = contents.replace("dummy_boundary_action", "")
@@ -123,6 +148,13 @@ def remove_dummy_repo_components(path):
                 contents = contents.replace(
                     "from .Dummy import dummy_control_action\n", ""
                 )
+                contents = contents.replace(
+                    "from .Dummy import dummy_control_actions\n", ""
+                )
+                contents = contents.replace(
+                    "control_actions.extend(dummy_control_actions)", ""
+                )
+
                 contents = contents.replace("dummy_control_action,\n", "")
                 contents = contents.replace("dummy_control_action,", "")
                 contents = contents.replace("dummy_control_action", "")
@@ -200,6 +232,8 @@ def remove_dummy_repo_components(path):
                 contents = contents.replace(
                     "from .Dummy import DummyCompoundType, DummyType1, DummyType2\n", ""
                 )
+                contents = contents.replace("from .Dummy import dummy_types\n", "")
+                contents = contents.replace("types.extend(dummy_types)", "")
                 contents = contents.replace(
                     """    DummyType1,
     DummyType2,

math_spec_mapping/Load/stateful_metrics.py

@@ -40,14 +40,14 @@ def convert_stateful_metric(ms, data: Dict) -> StatefulMetricSet:
                 x[1]
             )
 
-    var["implementations"] = {}
+        var["implementations"] = {}
+        if "python" in ms["Implementations"]:
+            if "stateful_metrics" in ms["Implementations"]["python"]:
+                if var["name"] in ms["Implementations"]["python"]["stateful_metrics"]:
+                    var["implementations"]["python"] = ms["Implementations"]["python"][
+                        "stateful_metrics"
+                    ][var["name"]]
 
-    if "python" in ms["Implementations"]:
-        if "stateful_metrics" in ms["Implementations"]["python"]:
-            if var["name"] in ms["Implementations"]["python"]["stateful_metrics"]:
-                var["implementations"]["python"] = ms["Implementations"]["python"][
-                    "stateful_metrics"
-                ][var["name"]]
         new_variables.append(StatefulMetric(var))
     data["metrics"] = new_variables
 

math_spec_mapping/Reports/__init__.py

@@ -7,6 +7,7 @@ from .html import (
     write_basic_report_full,
     write_action_chain_reports,
     write_spec_tree,
+    write_parameter_table,
     write_entity_reports,
     write_overview,
 )
@@ -26,3 +27,8 @@ from .markdown import (
     write_stateful_metrics_markdown_report,
     write_all_markdown_reports,
 )
+from .state import (
+    write_state_variable_table_markdown,
+    write_initial_state_variables_tables,
+)
+from .parameters import write_parameter_table_markdown

math_spec_mapping/Reports/html.py

@@ -6,7 +6,7 @@ from .policies import write_out_policies
 from .mechanisms import write_out_mechanisms
 from .general import load_svg_graphviz, write_header
 from .node_map import create_action_chains_graph
-from .parameters import write_out_params
+from .parameters import write_out_params, write_parameter_table_markdown
 from .state import write_local_state_variable_tables, write_global_state_variable_table
 from typing import List
 import os
@@ -267,3 +267,12 @@ def write_overview(ms: MathSpec, name: str, file_path: str, summary: str = None)
     out += write_spec_tree(ms, readme=True)
     with open(file_path, "w") as f:
         f.write(out)
+
+
+def write_parameter_table(ms: MathSpec, path=None, linking=False) -> str:
+    out = write_parameter_table_markdown(ms, links=linking)
+    if path:
+        with open("{}/Paramter Table.md".format(path), "w") as f:
+            f.write(out)
+    else:
+        return out

math_spec_mapping/Reports/parameters.py

@@ -13,3 +13,38 @@ def write_out_params(ms: MathSpec, params: List[str]) -> str:
         out += "<p>Parameter Class: {}</p>".format(param.parameter_class)
 
     return out
+
+
+def write_parameter_table_markdown(ms, initial_values=None, links=False):
+    if initial_values:
+        table = """| Name | Description | Parameter Class | Symbol | Domain | Initial Value |
+| --- | --- | --- | --- | --- | --- |
+"""
+    else:
+        table = """| Name | Description | Parameter Class | Symbol | Domain |
+| --- | --- | --- | --- | --- |
+"""
+
+    for name in ms.parameters.parameter_map:
+        var = ms.parameters.parameter_map[name]
+        table_vars = [
+            var.name,
+            var.description,
+            var.parameter_class,
+            var.symbol,
+            var.domain,
+        ]
+        table += "|"
+        for i, tv in enumerate(table_vars):
+            if tv:
+                if links and i == 0:
+                    table += "[[{}\|{}]]".format(tv, tv)
+                else:
+                    table += "{}".format(tv)
+            table += "|"
+        if initial_values:
+            table += " {} |".format(initial_values[var.name])
+
+        table += "\n"
+
+    return table

math_spec_mapping/Reports/state.py

@@ -33,8 +33,13 @@ def write_state_variable_table(target_state, links=False):
     return table
 
 
-def write_state_variable_table_markdown(target_state, links=False):
-    table = """| Name | Description | Type | Symbol | Domain |
+def write_state_variable_table_markdown(target_state, initial_values=None, links=False):
+    if initial_values:
+        table = """| Name | Description | Type | Symbol | Domain | Initial Value |
+| --- | --- | --- | --- | --- | --- |
+"""
+    else:
+        table = """| Name | Description | Type | Symbol | Domain |
 | --- | --- | --- | --- | --- |
 """
 
@@ -56,12 +61,33 @@ def write_state_variable_table_markdown(target_state, links=False):
                 else:
                     table += "{}".format(tv)
             table += "|"
+        if initial_values:
+            table += " {} |".format(initial_values[var.name])
 
         table += "\n"
 
     return table
 
 
+def write_initial_state_variables_tables(ms, initial_values, links=False):
+    out = "### Global State"
+    out += "\n\n"
+    out += write_state_variable_table_markdown(
+        ms.state["Global State"], initial_values=initial_values, links=links
+    )
+    out += "\n"
+    for x in ms.state:
+        if x == "Global State":
+            continue
+
+        out += "### {}".format(x)
+        out += "\n\n"
+        out += write_state_variable_table_markdown(ms.state[x], links=links)
+        out += "\n"
+
+    return out
+
+
 def write_global_state_variable_table(state):
     out = ""
     out += "<h3>Global State</h3>"

math_spec_mapping/__init__.py

@@ -8,6 +8,7 @@ from .Reports import (
     write_basic_report_full,
     write_action_chain_reports,
     write_spec_tree,
+    write_parameter_table,
     create_parameter_impact_table,
     write_entity_reports,
     write_wiring_report,
@@ -24,6 +25,9 @@ from .Reports import (
     write_parameter_markdown_report,
     write_stateful_metrics_markdown_report,
     write_all_markdown_reports,
+    write_state_variable_table_markdown,
+    write_initial_state_variables_tables,
+    write_parameter_table_markdown,
 )
 from .schema import schema
 from .Convenience import remove_dummy_repo_components

{math_spec_mapping-0.3.7.dist-info → math_spec_mapping-0.3.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: math-spec-mapping
-Version: 0.3.7
+Version: 0.3.9
 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.7.dist-info → math_spec_mapping-0.3.9.dist-info}/RECORD

@@ -1,4 +1,4 @@
-math_spec_mapping/__init__.py,sha256=CzT9KycdX5nuiUzDFmLXVeAIr8v8UKGbXsEQF8vjl1c,961
+math_spec_mapping/__init__.py,sha256=5n9PbwtdXymhFpL0uUOmcpCBfCEgDp2T93QIASC73ts,1107
 math_spec_mapping/schema.py,sha256=6mrRqzEnTTSXjb19xJ63MBp0KjKH0s7i6TfT4MkAY9k,233
 math_spec_mapping/schema.schema.json,sha256=hJP2TcV5WPFPmx4u_A5U1xtnpkE1LeYaTeYOXadTot0,30916
 math_spec_mapping/Classes/ActionTransmissionChannel.py,sha256=zWMo5QsgPh5WGIWXl-xOrZNMXYJXmK6Vejw1dQvi0og,246
@@ -6,7 +6,7 @@ math_spec_mapping/Classes/Block.py,sha256=cGtIhNgRfoDZ0O3SxeXcNzNlHcdXIB89sT2uaZ
 math_spec_mapping/Classes/BoundaryAction.py,sha256=KuZqtvZwSHWDP7gFQXGnG-r3EuYJU_oU9wMCuqvRkzk,593
 math_spec_mapping/Classes/ControlAction.py,sha256=ysqpgANwdizVdwqtgZmnxXMpCqrzmVEF_6YT0M3l4Ho,526
 math_spec_mapping/Classes/Entity.py,sha256=fA0-b128_OHHxfCg4pzqyQV083EYev1HlVpy86S5igg,1226
-math_spec_mapping/Classes/MathSpec.py,sha256=YopqG_ca7nxgPPZxQR9b442C155ZJGfs73CDEIL5uMc,39038
+math_spec_mapping/Classes/MathSpec.py,sha256=6cBpp9OHmfU-XTqPI4Qjnj91cXRxfGtcAQnczOKxt-4,39892
 math_spec_mapping/Classes/Mechanism.py,sha256=2sLm3wYBIeTQaMBcsJ9btqIWsbS895Ra8NY6Y9_G_Dg,379
 math_spec_mapping/Classes/Metric.py,sha256=AhPgYppOP6q49xvR8S9STxQsXUKJlTWx7wI1LfZEtww,581
 math_spec_mapping/Classes/Parameter.py,sha256=ZuJ_w0sChvRElJ4sOnXZ2EV4Ell2xXFulKLjVOpgz2E,1237
@@ -19,7 +19,7 @@ math_spec_mapping/Classes/Type.py,sha256=2KFY8d3cv1PzJJ7SSMHJf1zcfQ3ZbqxotK2KgTa
 math_spec_mapping/Classes/__init__.py,sha256=0zxgOqns_9JybD74HKMVh6aw8ij8WVbfQ4Q_1uWzof0,761
 math_spec_mapping/Convenience/__init__.py,sha256=z2W-E5Wg1CNEkDI5UqH3qIVBqp-3A1e63f3u9fA-N7w,112
 math_spec_mapping/Convenience/documentation.py,sha256=1ziWVJznbCUxeAAt03nAdEYtMlXNo5TeedHfgs0vSBU,1625
-math_spec_mapping/Convenience/starter.py,sha256=Pv0b5pHnv5Bxk3PkY8O9Nv62z2C_gxj5xcf8G9r4Pkw,11010
+math_spec_mapping/Convenience/starter.py,sha256=9dBKU3EHscut2wA6Nx1XUmehrFIdr4dCjP9V1BbTF6s,12567
 math_spec_mapping/Load/__init__.py,sha256=_ga5nHi7U5rY5lCF36_XI9Qmybq4P8R4m5I5mmjLBk8,33
 math_spec_mapping/Load/action_transmission_channel.py,sha256=9Wer7g2s5SSOcUYuZ0PqSKUVVnW3EvGQJZNXJTwW__0,2561
 math_spec_mapping/Load/boundary_actions.py,sha256=q-jxhu8FaKNjdOdexlK6f22GDgraGa1jnL5kEzQ7mJY,2625
@@ -35,26 +35,26 @@ math_spec_mapping/Load/parameters.py,sha256=W4utm7to3s2fo4z3XgLH0TM1agaIad1qfM2I
 math_spec_mapping/Load/policy.py,sha256=HvlhGHGJTweVs7DOI2HSL_2_diECr8ukDUmzoFLQELo,2444
 math_spec_mapping/Load/spaces.py,sha256=7zgGA57Te7T4hfuCCDElffiidWgn1lKm5E14e1yjt8M,1116
 math_spec_mapping/Load/state_update_transmission_channels.py,sha256=FJWp5n4HdtHAfof5BUQ6BnRakljatL2h8dWCapaVSc0,2238
-math_spec_mapping/Load/stateful_metrics.py,sha256=pX2w3MvX2akFAOo6XWybkRE_X-v5BqchV2jTx0EekF0,2356
+math_spec_mapping/Load/stateful_metrics.py,sha256=3Lq1ZGMaDd5OcGeqR2p5c_znkYw7ETTNPFjUVdZAHKk,2384
 math_spec_mapping/Load/states.py,sha256=3YurI7eTNkN6nrXRFVrc58wH0VfM22XOuWE07HVpR7Y,1365
 math_spec_mapping/Load/type.py,sha256=z6cBdBNjWed7cRyA0Bj7Jd5PmtemVVh07n3mWFj_5U4,4356
 math_spec_mapping/Load/wiring.py,sha256=1dR94U5N1W_WI5rL6lYBltH25ZvApB2pIpq9r5Opkug,3083
-math_spec_mapping/Reports/__init__.py,sha256=W27I6S9Ro1hWeHmnxIokCA06awB__eYey7PvKD4Hc1s,933
+math_spec_mapping/Reports/__init__.py,sha256=P3IuE1wiM1EO_yCSD73D4O0O6j7aVWmiwpKJM58ISEs,1121
 math_spec_mapping/Reports/boundary_actions.py,sha256=45BPp4QjWdD-3E9ZWwqgj_nI2-YdcI2ZZ19_Qv_K7Qk,1410
 math_spec_mapping/Reports/control_actions.py,sha256=NksekZKIPFSIkubttFstKFthc5AU9B9PWRLSl9j1wWs,1216
 math_spec_mapping/Reports/general.py,sha256=WOOn6Wlb8M4fsdN49FlKLwOka6vJPQ9aCUy88TL2ki0,1610
-math_spec_mapping/Reports/html.py,sha256=uUXxMgGoL2yQelSg7CmJjIsU84SbZarqPg2d9x7Z13k,9220
+math_spec_mapping/Reports/html.py,sha256=zRo67S81pIRK_sttuFy8Y06qllen_K0lNS1qeHQo5ik,9521
 math_spec_mapping/Reports/markdown.py,sha256=SdhgOMpMBnGKWDG0cimk-LI_UqjQDPy87IxTb-PrBQ0,22866
 math_spec_mapping/Reports/mechanisms.py,sha256=d2Rxt3JBYvqAOAYUynl0buYVoXEHrO8EGq7GK6hK8NA,1322
 math_spec_mapping/Reports/node_map.py,sha256=FdSMDQG16NX6n9sZcH-T5xwsvgjrV9OqBHc9J_VlNK0,3129
-math_spec_mapping/Reports/parameters.py,sha256=yizNG4lNGrgrlzYYcHMGfXKDFlPw4PMDYshDqZ3YARs,535
+math_spec_mapping/Reports/parameters.py,sha256=T73OKY3dWufeYEb6jSxGQH6GH4PSZLMmZcaV1m8qUn0,1553
 math_spec_mapping/Reports/policies.py,sha256=EuBzBsTM6QSS_GHFcAyhGgWvDDZwRuKe7Eos9nX13ho,1814
 math_spec_mapping/Reports/spaces.py,sha256=-76hR5wQBv4lsG000ypBJ-OprjsNjI-rNRMYdtsYnjQ,579
-math_spec_mapping/Reports/state.py,sha256=RkqfSonar74KVC8PpA9GgI2xaHX6BrkNdAuWMZlYQfI,2321
+math_spec_mapping/Reports/state.py,sha256=EPiHz3cDCEPHnVjuFruVKaGJ2SclUfGUFvvOukiHPNg,3110
 math_spec_mapping/Reports/tables.py,sha256=O0CNuqh3LMECq5uLjBOoxMUk5hUvkUK660FNnwWUxDY,1505
 math_spec_mapping/Reports/wiring.py,sha256=u9SvKWy6T-WJUEgFI6-zgZanoOaTTs_2YwmEceDLsV8,1618
-math_spec_mapping-0.3.7.dist-info/LICENSE,sha256=ObyEzSw8kgCaFbEfpu1zP4TrcAKLA0xhqHMZZfyh7N0,1069
-math_spec_mapping-0.3.7.dist-info/METADATA,sha256=Y4GIicxIeBa44LDgCxCdNAedQ7EZunZn-VD3JPMfFF4,6500
-math_spec_mapping-0.3.7.dist-info/WHEEL,sha256=mguMlWGMX-VHnMpKOjjQidIo1ssRlCFu4a4mBpz1s2M,91
-math_spec_mapping-0.3.7.dist-info/top_level.txt,sha256=AImhn9wgazkdV0a9vfiphtQR8uGe2nq-ZIOp-6yUk9o,18
-math_spec_mapping-0.3.7.dist-info/RECORD,,
+math_spec_mapping-0.3.9.dist-info/LICENSE,sha256=ObyEzSw8kgCaFbEfpu1zP4TrcAKLA0xhqHMZZfyh7N0,1069
+math_spec_mapping-0.3.9.dist-info/METADATA,sha256=LHloXu-KQrrxTtV_ds9ZnHzTRiQ2w-08YvPSrOKP4nY,6500
+math_spec_mapping-0.3.9.dist-info/WHEEL,sha256=Wyh-_nZ0DJYolHNn1_hMa4lM7uDedD_RGVwbmTjyItk,91
+math_spec_mapping-0.3.9.dist-info/top_level.txt,sha256=AImhn9wgazkdV0a9vfiphtQR8uGe2nq-ZIOp-6yUk9o,18
+math_spec_mapping-0.3.9.dist-info/RECORD,,

{math_spec_mapping-0.3.7.dist-info → math_spec_mapping-0.3.9.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (70.1.1)
+Generator: setuptools (71.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any