Skip to content

Commit ddf14a8

Browse files
committed
Add extra report stuff
1 parent 8dbe7f9 commit ddf14a8

File tree

6 files changed

+21
-5
lines changed

6 files changed

+21
-5
lines changed

docs/CanonicalExamples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Canonical Examples
33
layout: page
4-
nav_order: 6
4+
nav_order: 7
55
---
66

77
As part of MSML, there are multiple canonical examples which are meant to showcase how the library gets used. The table below describes the features that each one has as well as the level of completion for each.

docs/FAQ.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: FAQ
33
layout: page
4-
nav_order: 8
4+
nav_order: 9
55
---
66

77
The following are frequently asked questions with regards to MSML.

docs/Reports.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: Reports
3+
layout: page
4+
nav_order: 6
5+
---
6+
7+
MSML has a variety of reports that can be produced in markdown files which can also be converted to PDF.
8+
9+
## PDF Conversion
10+
11+
- To use PDF conversion, a few other things need to be installed
12+
- One must install pandoc, which can be done with "brew install pandoc" on a mac
13+
- Installing pdflatex might be required which can be done with "brew install --cask basictex" on a mac
14+
- If the pdflatex path is not recognized by the system, you may need to pass the path to it. For example, on a mac this would be: pdflatex_path='/Library/TeX/texbin/pdflatex'

docs/cadCADBuilder.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: cadCAD Builder
33
layout: page
4-
nav_order: 7
4+
nav_order: 8
55
---
66

77
MSML provides interfaces for creating cadCAD style models that don't require end users poking around the actual code to use. The idea is that it provides a layer for data scientists to experiment just with toggling starting state and parameters and executing pre-packaged models.

pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ dependencies = [
1414
"pandas>=1.4",
1515
"jsonschema>=4.21.1",
1616
"PyGithub==2.5.0",
17-
"python-dotenv>=1.0.0"
17+
"python-dotenv>=1.0.0",
18+
"pypandoc>=1.15",
1819
]
1920
readme = "README.md"
2021
requires-python = ">=3.7"

requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@ ipython>=7.7.0
33
pandas>=1.4
44
jsonschema>=4.21.1
55
PyGithub==2.5.0
6-
python-dotenv>=1.0.0
6+
python-dotenv>=1.0.0
7+
pypandoc>=1.15

0 commit comments

Comments
 (0)