math-spec-mapping 0.3.10__py3-none-any.whl → 0.3.12__py3-none-any.whl

math_spec_mapping/Classes/MathSpec.py

@@ -8,6 +8,7 @@ import os
 from copy import deepcopy
 import shutil
 import pandas as pd
+from inspect import signature, getsource
 
 
 class MathSpec:
@@ -47,6 +48,7 @@ class MathSpec:
         self._build_functional_parameters()
         self._build_parameter_types()
         self._crawl_spaces()
+        self._set_source_code()
 
     def _check_dictionary_names(self):
         for key in self.boundary_actions:
@@ -765,6 +767,15 @@ using .Spaces: generate_space_type
     def build_implementation(self, params):
         return MathSpecImplementation(self, params)
 
+    def _set_source_code(self):
+        if "python" not in self.implementations:
+            self.source_code = None
+            return
+        self.source_code = deepcopy(self.implementations["python"])
+        for x in self.source_code:
+            for y in self.source_code[x]:
+                self.source_code[x][y] = getsource(self.source_code[x][y])
+
 
 class MathSpecImplementation:
     def __init__(self, ms: MathSpec, params):
@@ -778,6 +789,7 @@ class MathSpecImplementation:
         self.metrics = self.load_metrics()
         self.load_wiring()
         self.load_components()
+        self.load_source_files()
 
     def load_control_actions(self):
         control_actions = {}
@@ -1046,13 +1058,27 @@ class MathSpecImplementation:
         state["Metrics"] = self.metrics
         if state_preperation_functions:
             for f in state_preperation_functions:
-                state = f(state)
+                if len(signature(f).parameters) == 1:
+                    state = f(state)
+                elif len(signature(f).parameters) == 2:
+                    state = f(state, params)
+                else:
+                    assert (
+                        False
+                    ), "Incorrect number of parameters for the state preperation function"
                 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)
+                if len(signature(f).parameters) == 1:
+                    params = f(params)
+                elif len(signature(f).parameters) == 2:
+                    params = f(params, state)
+                else:
+                    assert (
+                        False
+                    ), "Incorrect number of parameters for the state preperation function"
                 assert (
                     params is not None
                 ), "A parameter set must be returned from the parameter preperation functions"
@@ -1070,3 +1096,16 @@ class MathSpecImplementation:
         for block in blocks:
             self.components[block](state, params, [])
         return state
+
+    def load_source_files(self):
+        self.source_files = {}
+        for key in self.components:
+            self.source_files[key] = getsource(self.components[key])
+
+    def print_source_code_files(self, keys=None):
+        if not keys:
+            keys = list(self.source_files.keys())
+        for key in keys:
+            print("-" * 20 + key + "-" * 20)
+            print(self.source_files[key])
+            print("\n\n\n")

math_spec_mapping/Reports/parameters.py

@@ -15,7 +15,9 @@ def write_out_params(ms: MathSpec, params: List[str]) -> str:
     return out
 
 
-def write_parameter_table_markdown(ms, initial_values=None, links=False):
+def write_parameter_table_markdown(
+    ms, initial_values=None, links=False, compress_arrays=False
+):
     if initial_values:
         table = """| Name | Description | Parameter Class | Symbol | Domain | Initial Value |
 | --- | --- | --- | --- | --- | --- |
@@ -43,7 +45,16 @@ def write_parameter_table_markdown(ms, initial_values=None, links=False):
                     table += "{}".format(tv)
             table += "|"
         if initial_values:
-            table += " {} |".format(initial_values[var.name])
+            if compress_arrays:
+                iv = initial_values[var.name]
+                if type(iv) == list:
+                    if len(iv) > 4:
+                        iv = "[{}, {}, ... , {}, {}]".format(
+                            iv[0], iv[1], iv[-2], iv[-1]
+                        )
+                table += " {} |".format(iv)
+            else:
+                table += " {} |".format(initial_values[var.name])
 
         table += "\n"
 

math_spec_mapping/Reports/state.py

@@ -33,7 +33,9 @@ def write_state_variable_table(target_state, links=False):
     return table
 
 
-def write_state_variable_table_markdown(target_state, initial_values=None, links=False):
+def write_state_variable_table_markdown(
+    target_state, initial_values=None, links=False, compress_arrays=False
+):
     if initial_values:
         table = """| Name | Description | Type | Symbol | Domain | Initial Value |
 | --- | --- | --- | --- | --- | --- |
@@ -62,18 +64,32 @@ def write_state_variable_table_markdown(target_state, initial_values=None, links
                     table += "{}".format(tv)
             table += "|"
         if initial_values:
-            table += " {} |".format(initial_values[var.name])
+            if compress_arrays:
+                iv = initial_values[var.name]
+                if type(iv) == list:
+                    if len(iv) > 4:
+                        iv = "[{}, {}, ... , {}, {}]".format(
+                            iv[0], iv[1], iv[-2], iv[-1]
+                        )
+                table += " {} |".format(iv)
+            else:
+                table += " {} |".format(initial_values[var.name])
 
         table += "\n"
 
     return table
 
 
-def write_initial_state_variables_tables(ms, initial_values, links=False):
+def write_initial_state_variables_tables(
+    ms, initial_values, links=False, compress_arrays=False
+):
     out = "### Global State"
     out += "\n\n"
     out += write_state_variable_table_markdown(
-        ms.state["Global State"], initial_values=initial_values, links=links
+        ms.state["Global State"],
+        initial_values=initial_values,
+        links=links,
+        compress_arrays=compress_arrays,
     )
     out += "\n"
     for x in ms.state:
@@ -82,7 +98,9 @@ def write_initial_state_variables_tables(ms, initial_values, links=False):
 
         out += "### {}".format(x)
         out += "\n\n"
-        out += write_state_variable_table_markdown(ms.state[x], links=links)
+        out += write_state_variable_table_markdown(
+            ms.state[x], links=links, compress_arrays=compress_arrays
+        )
         out += "\n"
 
     return out

{math_spec_mapping-0.3.10.dist-info → math_spec_mapping-0.3.12.dist-info}/METADATA

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

@@ -6,7 +6,7 @@ math_spec_mapping/Classes/Block.py,sha256=cGtIhNgRfoDZ0O3SxeXcNzNlHcdXIB89sT2uaZ
 math_spec_mapping/Classes/BoundaryAction.py,sha256=_rFvEZ4LNxmlM59js4SuQ9n5CgVmITw4YWKs0-q0r-4,560
 math_spec_mapping/Classes/ControlAction.py,sha256=4AzMSA8fbnUf-fGlvMJXHJFbz32G1h1QVWf2yzrXrLA,493
 math_spec_mapping/Classes/Entity.py,sha256=fA0-b128_OHHxfCg4pzqyQV083EYev1HlVpy86S5igg,1226
-math_spec_mapping/Classes/MathSpec.py,sha256=8gU1EgVuiHjI7olVXJiPgFQlDUF2sEcjmGZ2cQv86k0,40475
+math_spec_mapping/Classes/MathSpec.py,sha256=MnQQQMAk8VojjTzao56MBN3rvO_fexQrkh5SAGmWpP8,42033
 math_spec_mapping/Classes/Mechanism.py,sha256=2sLm3wYBIeTQaMBcsJ9btqIWsbS895Ra8NY6Y9_G_Dg,379
 math_spec_mapping/Classes/Metric.py,sha256=iQhH4g8Z60QlM22nPX9ytGmidOsZSiSs0KjqwmsScwU,636
 math_spec_mapping/Classes/Parameter.py,sha256=ZuJ_w0sChvRElJ4sOnXZ2EV4Ell2xXFulKLjVOpgz2E,1237
@@ -47,14 +47,14 @@ math_spec_mapping/Reports/html.py,sha256=zRo67S81pIRK_sttuFy8Y06qllen_K0lNS1qeHQ
 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=T73OKY3dWufeYEb6jSxGQH6GH4PSZLMmZcaV1m8qUn0,1553
+math_spec_mapping/Reports/parameters.py,sha256=-ucL71lolqU0xvV7yb0sXl4pFMRl5tXNWdoBfUjLOaQ,1944
 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=EPiHz3cDCEPHnVjuFruVKaGJ2SclUfGUFvvOukiHPNg,3110
+math_spec_mapping/Reports/state.py,sha256=QYeCvX5cHeZBrbvMeDsTqJcUDTuDFJSLvPbasjLspk8,3643
 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.10.dist-info/LICENSE,sha256=ObyEzSw8kgCaFbEfpu1zP4TrcAKLA0xhqHMZZfyh7N0,1069
-math_spec_mapping-0.3.10.dist-info/METADATA,sha256=GeiDgMZu2pfRgBwMMI1hG4dioScjJ0C3qH8AhN9Ewm4,6501
-math_spec_mapping-0.3.10.dist-info/WHEEL,sha256=HiCZjzuy6Dw0hdX5R3LCFPDmFS4BWl8H-8W39XfmgX4,91
-math_spec_mapping-0.3.10.dist-info/top_level.txt,sha256=AImhn9wgazkdV0a9vfiphtQR8uGe2nq-ZIOp-6yUk9o,18
-math_spec_mapping-0.3.10.dist-info/RECORD,,
+math_spec_mapping-0.3.12.dist-info/LICENSE,sha256=ObyEzSw8kgCaFbEfpu1zP4TrcAKLA0xhqHMZZfyh7N0,1069
+math_spec_mapping-0.3.12.dist-info/METADATA,sha256=0vIDBOENySVkVAwdDuRbtZ84uOKAEwWLj9qwaR6-Mh8,6501
+math_spec_mapping-0.3.12.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+math_spec_mapping-0.3.12.dist-info/top_level.txt,sha256=AImhn9wgazkdV0a9vfiphtQR8uGe2nq-ZIOp-6yUk9o,18
+math_spec_mapping-0.3.12.dist-info/RECORD,,

{math_spec_mapping-0.3.10.dist-info → math_spec_mapping-0.3.12.dist-info}/WHEEL

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