math-spec-mapping 0.3.10__tar.gz → 0.3.12__tar.gz

{math_spec_mapping-0.3.10/src/math_spec_mapping.egg-info → math_spec_mapping-0.3.12}/PKG-INFO

@@ -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 → math_spec_mapping-0.3.12}/pyproject.toml

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

{math_spec_mapping-0.3.10 → math_spec_mapping-0.3.12}/src/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-0.3.10 → math_spec_mapping-0.3.12}/src/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-0.3.10 → math_spec_mapping-0.3.12}/src/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 → math_spec_mapping-0.3.12/src/math_spec_mapping.egg-info}/PKG-INFO

@@ -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