math-spec-mapping 0.4.2__py3-none-any.whl → 0.4.3__py3-none-any.whl

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/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/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/__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 (

{math_spec_mapping-0.4.2.dist-info → math_spec_mapping-0.4.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: math-spec-mapping
-Version: 0.4.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)
 

{math_spec_mapping-0.4.2.dist-info → math_spec_mapping-0.4.3.dist-info}/RECORD

@@ -1,4 +1,4 @@
-math_spec_mapping/__init__.py,sha256=-w5j-DhqAUF9vI7k8SlqMiq39MeATebE6MCw5F2ozk4,1282
+math_spec_mapping/__init__.py,sha256=8MbUccubjXcwkTrwi3AD8uFhokRYPwLXURNTLCnSbRM,1338
 math_spec_mapping/schema.py,sha256=6mrRqzEnTTSXjb19xJ63MBp0KjKH0s7i6TfT4MkAY9k,233
 math_spec_mapping/schema.schema.json,sha256=NyzUy899YR_5Y956ID5HQtgnRBrNTAN6QjrqCyBasRA,31005
 math_spec_mapping/Classes/ActionTransmissionChannel.py,sha256=zWMo5QsgPh5WGIWXl-xOrZNMXYJXmK6Vejw1dQvi0og,246
@@ -42,10 +42,11 @@ math_spec_mapping/Load/stateful_metrics.py,sha256=eNXIsNmezVN75L3zMXUl8_JORShm_o
 math_spec_mapping/Load/states.py,sha256=3YurI7eTNkN6nrXRFVrc58wH0VfM22XOuWE07HVpR7Y,1365
 math_spec_mapping/Load/type.py,sha256=pIo3lYAP6sxukvbFTDvaun1lslgShksZy2froNnwAfA,4973
 math_spec_mapping/Load/wiring.py,sha256=l1FhHNFRMKorn1oiRhsuMDsExcXnUmTjqQt5ElE-Bbk,3258
-math_spec_mapping/Reports/__init__.py,sha256=P3IuE1wiM1EO_yCSD73D4O0O6j7aVWmiwpKJM58ISEs,1121
+math_spec_mapping/Reports/__init__.py,sha256=OqmAKio9if1OknLoiTWTpaVq3PzfUCZdIEmZj3wS0z8,1190
+math_spec_mapping/Reports/advanced.py,sha256=Y75ZYPBpr_HOJ64BrsjA5Rc0vmqiiTcEQWx8orOT74Q,1767
 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/general.py,sha256=CSF5DZgZerUZ6Bdnt0mfzM-2QEUwnvC_JeveE7ngtTs,2024
 math_spec_mapping/Reports/html.py,sha256=MCVp_D1LuRoZrHtwzFOJGQviztGeahqsWf3Zue1Yz64,10134
 math_spec_mapping/Reports/markdown.py,sha256=2WYZYzIubtNb-OyZCOK5nS_O9jPOsdwAtMMJJOt-ZDk,30657
 math_spec_mapping/Reports/mechanisms.py,sha256=d2Rxt3JBYvqAOAYUynl0buYVoXEHrO8EGq7GK6hK8NA,1322
@@ -56,8 +57,8 @@ math_spec_mapping/Reports/spaces.py,sha256=-76hR5wQBv4lsG000ypBJ-OprjsNjI-rNRMYd
 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.4.2.dist-info/LICENSE,sha256=ObyEzSw8kgCaFbEfpu1zP4TrcAKLA0xhqHMZZfyh7N0,1069
-math_spec_mapping-0.4.2.dist-info/METADATA,sha256=_JU9rnSp9fWd55xL0_1g3NozwwWuG3hhYABqrr0IDmU,7034
-math_spec_mapping-0.4.2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-math_spec_mapping-0.4.2.dist-info/top_level.txt,sha256=AImhn9wgazkdV0a9vfiphtQR8uGe2nq-ZIOp-6yUk9o,18
-math_spec_mapping-0.4.2.dist-info/RECORD,,
+math_spec_mapping-0.4.3.dist-info/LICENSE,sha256=ObyEzSw8kgCaFbEfpu1zP4TrcAKLA0xhqHMZZfyh7N0,1069
+math_spec_mapping-0.4.3.dist-info/METADATA,sha256=6NFRaAlIrw6h_8802HicQ2P-8KUUrIDAOkWhY6Ys72w,7064
+math_spec_mapping-0.4.3.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+math_spec_mapping-0.4.3.dist-info/top_level.txt,sha256=AImhn9wgazkdV0a9vfiphtQR8uGe2nq-ZIOp-6yUk9o,18
+math_spec_mapping-0.4.3.dist-info/RECORD,,