search

shirtsgroup / physical_validation

Physical validation of molecular simulations
https://physical-validation.readthedocs.io
MIT License
55 stars 19 forks source link

make notebooks clearer #166

Closed mrshirts closed 2 years ago

mrshirts commented 3 years ago

Description

make it clearer which pages are notebooks.

codecov[bot] commented 3 years ago

Codecov Report

Merging #166 (3650dd4) into master (4ce0fff) will not change coverage. The diff coverage is n/a.

mrshirts commented 3 years ago

I'm not particularly set on any particular way to do it. But I do think that if people want to download the data to run on their own, it's very confusing as is. There should be a link where they can download an .ipynb file to their computer - right now, the link only leads to an html file, and there's no obvious thing to do to get a .ipynb file.

ptmerz commented 3 years ago

@mrshirts does this new version address your points? I have renamed "notebook" to "example" to avoid confusions for readers of the html documentation. When looking at the notebook, there is now a note on how they can be run locally. Note that simply downloading the notebook wouldn't be enough - the examples need to be present to run the notebooks.

There's a build of the doc as suggested in this PR here: https://physical-validation--166.org.readthedocs.build/en/166/index.html

mrshirts commented 3 years ago

Sure, I think this is clear enough for people. It shows how to get the notebook.