math-spec-mapping 0.4.1.2__tar.gz → 0.4.3__tar.gz

{math_spec_mapping-0.4.1.2/src/math_spec_mapping.egg-info → math_spec_mapping-0.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: math-spec-mapping
-Version: 0.4.1.2
+Version: 0.4.3
 Summary: A library for easy mapping of mathematical specifications.
 Author-email: Sean McOwen <Sean@Block.Science>
 Classifier: Programming Language :: Python :: 3
@@ -15,6 +15,7 @@ Requires-Dist: pandas>=1.4
 Requires-Dist: jsonschema>=4.21.1
 Requires-Dist: PyGithub==2.5.0
 Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pypandoc>=1.15
 
 # Mathematical Specification Mapping Library (MSML)
 
@@ -30,7 +31,7 @@ One good example is the [wiring report](https://github.com/BlockScience/Predator
 
 ## Installing the library
 
-To install the library, simply pip install by running "pip install math_spec_mapping"
+To install the library, simply pip install by running "pip install math-spec-mapping". The pypi package can be found [here](https://pypi.org/project/math-spec-mapping/).
 
 ## Why MSML?
 

{math_spec_mapping-0.4.1.2 → math_spec_mapping-0.4.3}/README.md

@@ -12,7 +12,7 @@ One good example is the [wiring report](https://github.com/BlockScience/Predator
 
 ## Installing the library
 
-To install the library, simply pip install by running "pip install math_spec_mapping"
+To install the library, simply pip install by running "pip install math-spec-mapping". The pypi package can be found [here](https://pypi.org/project/math-spec-mapping/).
 
 ## Why MSML?
 

{math_spec_mapping-0.4.1.2 → math_spec_mapping-0.4.3}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools>=61.0"]
 build-backend = "setuptools.build_meta"
 [project]
 name = "math-spec-mapping"
-version = "0.4.1.2"
+version = "0.4.3"
 authors = [
   { name="Sean McOwen", email="Sean@Block.Science" },
 ]
@@ -14,7 +14,8 @@ dependencies = [
   "pandas>=1.4",
   "jsonschema>=4.21.1",
   "PyGithub==2.5.0",
-  "python-dotenv>=1.0.0"
+  "python-dotenv>=1.0.0",
+  "pypandoc>=1.15",
 ]
 readme = "README.md"
 requires-python = ">=3.7"

{math_spec_mapping-0.4.1.2 → math_spec_mapping-0.4.3}/src/math_spec_mapping/Classes/MathSpec.py

@@ -1041,10 +1041,25 @@ using .Spaces: generate_space_type
         blocks,
         state_preperation_functions=[],
         parameter_preperation_functions=[],
+        fixed_parameters=None,
+        fixed_state=None,
     ):
         out = {}
         out["StateSpace"] = self._build_state_space()
+        if fixed_state:
+            for key in fixed_state:
+                assert (
+                    key in out["StateSpace"]
+                ), "The fixed parameter {} is not in the state space".format(key)
+                out["StateSpace"].pop(key)
+
         out["ParameterSpace"] = self._build_parameter_space()
+        if fixed_parameters:
+            for key in fixed_parameters:
+                assert (
+                    key in out["ParameterSpace"]
+                ), "The fixed parameter {} is not in the parameter space".format(key)
+                out["ParameterSpace"].pop(key)
         out["Model"] = cadCADModel(
             self,
             out["StateSpace"],
@@ -1052,6 +1067,8 @@ using .Spaces: generate_space_type
             blocks,
             state_preperation_functions=state_preperation_functions,
             parameter_preperation_functions=parameter_preperation_functions,
+            fixed_parameters=fixed_parameters,
+            fixed_state=fixed_state,
         )
         return out
 
@@ -1079,6 +1096,8 @@ class cadCADModel:
         blocks,
         state_preperation_functions=[],
         parameter_preperation_functions=[],
+        fixed_parameters=None,
+        fixed_state=None,
     ):
         self.ms = ms
         self.state_space = state_space
@@ -1086,10 +1105,18 @@ class cadCADModel:
         self.blocks = blocks
         self.state_preperation_functions = state_preperation_functions
         self.parameter_preperation_functions = parameter_preperation_functions
+        self.fixed_parameters = fixed_parameters
+        self.fixed_state = fixed_state
 
     def create_experiment(
         self, state, params, record_trajectory=False, use_deepcopy=True
     ):
+        if self.fixed_state:
+            for x in self.fixed_state:
+                state[x] = self.fixed_state[x]
+        if self.fixed_parameters:
+            for x in self.fixed_parameters:
+                params[x] = self.fixed_parameters[x]
         return Experiment(
             self,
             state,
@@ -1180,11 +1207,11 @@ class BatchExperiments:
     def step(self):
         for experiment in self.experiments:
             experiment.step()
-    
+
     def run(self, t):
         for experiment in self.experiments:
             experiment.run(t)
-    
+
     @property
     def trajectories(self):
         return [experiment.trajectories for experiment in self.experiments]

{math_spec_mapping-0.4.1.2 → math_spec_mapping-0.4.3}/src/math_spec_mapping/Convenience/__init__.py

@@ -6,3 +6,4 @@ from .github import (
     create_priority_label_matrix,
     create_milestone_label_matrix,
 )
+from .cadCAD import get_nested_types

math_spec_mapping-0.4.3/src/math_spec_mapping/Convenience/cadCAD.py

@@ -0,0 +1,21 @@
+from copy import deepcopy
+from typing import _TypedDictMeta, _GenericAlias
+
+
+def get_underlying_type(data):
+    if type(data) == _GenericAlias:
+        data = [get_underlying_type(x) for x in data.__args__]
+    elif type(data) == _TypedDictMeta:
+        data = get_nested_types(data.__annotations__)
+    return data
+
+
+def get_nested_types(data):
+    data = deepcopy(data)
+    for key in data:
+        if type(data[key]) == _TypedDictMeta:
+            data[key] = get_nested_types(data[key].__annotations__)
+        elif type(data[key]) == _GenericAlias:
+            data[key] = get_underlying_type(data[key])
+
+    return data

{math_spec_mapping-0.4.1.2 → math_spec_mapping-0.4.3}/src/math_spec_mapping/Load/load.py

@@ -86,4 +86,8 @@ def load_from_json(json: Dict, spec_path=None) -> MathSpec:
     if spec_path:
         tree = load_spec_tree(spec_path, ms)
         ms._add_spec_tree(tree)
+    else:
+        print(
+            "Add spec path to load_from_json to load spec tree and allow linking to the code in Obsidian"
+        )
     return ms

{math_spec_mapping-0.4.1.2 → math_spec_mapping-0.4.3}/src/math_spec_mapping/Reports/__init__.py

@@ -2,7 +2,7 @@ from .node_map import create_action_chains_graph
 from .boundary_actions import write_out_boundary_actions
 from .policies import write_out_policies
 from .mechanisms import write_out_mechanisms
-from .general import load_svg_graphviz
+from .general import load_svg_graphviz, convert_markdown_to_pdf
 from .html import (
     write_basic_report_full,
     write_action_chain_reports,
@@ -32,3 +32,4 @@ from .state import (
     write_initial_state_variables_tables,
 )
 from .parameters import write_parameter_table_markdown
+from .advanced import write_glossary_report

math_spec_mapping-0.4.3/src/math_spec_mapping/Reports/advanced.py

@@ -0,0 +1,57 @@
+from ..Classes import MathSpec
+from .state import write_state_section
+
+
+def write_glossary_report(ms: MathSpec, directory: str) -> None:
+    """Function to write a report of each component and its description in MSML
+
+    Args:
+        ms (MathSpec): The mathematical specification object
+        directory (str): Directory to put reports into
+    """
+    out = "# Glossary\n\n"
+
+    out += "## Entities\n\n"
+    for entity in ms.entities:
+        if entity == "Global":
+            continue
+        entity = ms.entities[entity]
+        out += "**{}**: {}".format(entity.name, entity.notes)
+        out += "\n\n"
+    out += "\n"
+
+    out += "## State\n\n"
+    states = list(ms.state.keys())
+    states.remove("Global State")
+    states = ["Global State"] + states
+    for state in states:
+        out += "### {}\n\n".format(state)
+        out += write_state_section(ms.state[state])
+        out += "\n\n"
+    out += "\n\n"
+
+    for name, component in [
+        ["Types", ms.types],
+        ["Spaces", ms.spaces],
+        ["Boundary Actions", ms.boundary_actions],
+        ["Control Actions", ms.control_actions],
+        ["Policies", ms.policies],
+        ["Mechanisms", ms.mechanisms],
+        ["Wiring", ms.wiring],
+        ["Parameters", ms.parameters.parameter_map],
+        ["Stateful Metrics", ms.stateful_metrics],
+        ["Metrics", ms.metrics],
+    ]:
+        out += "## {}\n\n".format(name)
+        for key in component:
+            if hasattr(component[key], "description"):
+                desc = component[key].description
+            else:
+                desc = component[key].notes
+
+            out += "**{}**: {}\n\n".format(key, desc)
+        out += "\n\n"
+
+    path = directory + "/Glossary.md"
+    with open(path, "w") as f:
+        f.write(out)

{math_spec_mapping-0.4.1.2 → math_spec_mapping-0.4.3}/src/math_spec_mapping/Reports/general.py

@@ -1,5 +1,6 @@
 from graphviz import Digraph
 import os
+import pypandoc
 
 
 def load_svg_graphviz(graph: Digraph, overwrite: bool = False) -> str:
@@ -23,7 +24,7 @@ def load_svg_graphviz(graph: Digraph, overwrite: bool = False) -> str:
         assert "{}.gv".format(graph.name) not in os.listdir(".")
 
     # Render the graph
-    graph.render(directory=".", format='svg')
+    graph.render(directory=".", format="svg")
 
     # Read the svg
     with open("./{}.gv.svg".format(graph.name), "r") as f:
@@ -35,6 +36,7 @@ def load_svg_graphviz(graph: Digraph, overwrite: bool = False) -> str:
 
     return svg
 
+
 def write_header() -> str:
     out = '<p>For explanations of generalized dynamical systems as well as how the mathematical specification library works in detail, please consult the documentation <a href="https://github.com/BlockScience/MSML/tree/main/docs">here</a></p>'
     out += "Graph Legend:<br/>"
@@ -43,4 +45,20 @@ def write_header() -> str:
     out += "Red Square: Policy<br/>"
     out += "Blue Circle: Mechanism<br/>"
     out += "Transparent Circle: State Variable"
-    return out
+    return out
+
+
+def convert_markdown_to_pdf(md_path, pdf_path, pdflatex_path=None):
+    if pdflatex_path:
+        pypandoc.convert_file(
+            md_path,
+            "pdf",
+            outputfile=pdf_path,
+            extra_args=["--pdf-engine={}".format(pdflatex_path)],
+        )
+    else:
+        pypandoc.convert_file(
+            md_path,
+            "pdf",
+            outputfile=pdf_path,
+        )

{math_spec_mapping-0.4.1.2 → math_spec_mapping-0.4.3}/src/math_spec_mapping/Reports/markdown.py

@@ -70,7 +70,10 @@ def write_source_code_block(component, text, path):
     if hasattr(component, "source_code_location"):
         file_path = component.source_code_location
     else:
-        file_path = component["Source Code Location"]
+        try:
+            file_path = component["Source Code Location"]
+        except:
+            file_path = None
     if file_path:
         file_path = os.path.relpath(file_path, path)
         text += "## Spec Source Code Location\n\n"

{math_spec_mapping-0.4.1.2 → math_spec_mapping-0.4.3}/src/math_spec_mapping/__init__.py

@@ -28,6 +28,8 @@ from .Reports import (
     write_state_variable_table_markdown,
     write_initial_state_variables_tables,
     write_parameter_table_markdown,
+    write_glossary_report,
+    convert_markdown_to_pdf,
 )
 from .schema import schema
 from .Convenience import (
@@ -36,6 +38,7 @@ from .Convenience import (
     find_open_issues,
     create_priority_label_matrix,
     create_milestone_label_matrix,
+    get_nested_types,
 )
 
 # from .Convenience import write_top_level_json_description

{math_spec_mapping-0.4.1.2 → math_spec_mapping-0.4.3/src/math_spec_mapping.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: math-spec-mapping
-Version: 0.4.1.2
+Version: 0.4.3
 Summary: A library for easy mapping of mathematical specifications.
 Author-email: Sean McOwen <Sean@Block.Science>
 Classifier: Programming Language :: Python :: 3
@@ -15,6 +15,7 @@ Requires-Dist: pandas>=1.4
 Requires-Dist: jsonschema>=4.21.1
 Requires-Dist: PyGithub==2.5.0
 Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pypandoc>=1.15
 
 # Mathematical Specification Mapping Library (MSML)
 
@@ -30,7 +31,7 @@ One good example is the [wiring report](https://github.com/BlockScience/Predator
 
 ## Installing the library
 
-To install the library, simply pip install by running "pip install math_spec_mapping"
+To install the library, simply pip install by running "pip install math-spec-mapping". The pypi package can be found [here](https://pypi.org/project/math-spec-mapping/).
 
 ## Why MSML?
 

{math_spec_mapping-0.4.1.2 → math_spec_mapping-0.4.3}/src/math_spec_mapping.egg-info/SOURCES.txt

@@ -26,6 +26,7 @@ src/math_spec_mapping/Classes/StatefulMetric.py
 src/math_spec_mapping/Classes/Type.py
 src/math_spec_mapping/Classes/__init__.py
 src/math_spec_mapping/Convenience/__init__.py
+src/math_spec_mapping/Convenience/cadCAD.py
 src/math_spec_mapping/Convenience/documentation.py
 src/math_spec_mapping/Convenience/github.py
 src/math_spec_mapping/Convenience/starter.py
@@ -50,6 +51,7 @@ src/math_spec_mapping/Load/states.py
 src/math_spec_mapping/Load/type.py
 src/math_spec_mapping/Load/wiring.py
 src/math_spec_mapping/Reports/__init__.py
+src/math_spec_mapping/Reports/advanced.py
 src/math_spec_mapping/Reports/boundary_actions.py
 src/math_spec_mapping/Reports/control_actions.py
 src/math_spec_mapping/Reports/general.py

{math_spec_mapping-0.4.1.2 → math_spec_mapping-0.4.3}/src/math_spec_mapping.egg-info/requires.txt

@@ -4,3 +4,4 @@ pandas>=1.4
 jsonschema>=4.21.1
 PyGithub==2.5.0
 python-dotenv>=1.0.0
+pypandoc>=1.15