AU-BCE-EE / tric-fil-mod

A trickling filter model to simulate air treatment, written in Python
GNU General Public License v3.0
0 stars 0 forks source link

Document tests using Markdown #12

Open sashahafner opened 1 year ago

sashahafner commented 1 year ago

See if there is something like RMarkdown for Python

sashahafner commented 1 year ago

https://python-markdown.github.io/

Now to find some documentation. . .

sashahafner commented 1 year ago

https://python-markdown.github.io/

Now to find some documentation. . .

Good luck

sashahafner commented 1 year ago

Not sure why this needs to be so complicated

https://stackoverflow.com/questions/38308620/mix-python-output-and-markdown-in-jupyter

Might be simplest to use RMarkdown with Python chunks

https://bookdown.org/yihui/rmarkdown-cookbook/eng-python.html

sashahafner commented 1 year ago

See related issue here: https://github.com/sashahafner/pystupid/issues/4

sashahafner commented 1 year ago

@afeilberg see https://github.com/AU-BCE-EE/tric-fil-mod/blob/main/demos/07_calc_Kga/demo.pdf for an example of a report. I could not find a simple approach to do this in just Python, and this approach actually uses R for document processing. I may be overlooking something (but maybe not, Python often surprises me) and will keep looking around for a Python-only approach.

6cf45ce1ba04bf156de3a02c804b3adcb1c86031

But to use this approach you

sashahafner commented 1 year ago

Task: figure out how to make this easy to use in RStudio on different operating systems.

sashahafner commented 1 year ago

The operating system info extracted in an example here was helpful:

http://127.0.0.1:13601/library/utils/html/shortPathName.html

sashahafner commented 1 year ago

@afeilberg see demos/09_time_variable_clin/demo.Rmd. You should be able to run all the code and compiled the pdf on Windows through e.g., RStudio. You'll have to change the path to your Python executable. If you do that and push a corrected version I'll just use that path in future Rmd files.

Let me know if you find a simpler approach.