search

Edinburgh-Chemistry-Teaching / Data-driven-chemistry

Creative Commons Attribution 4.0 International
21 stars 2 forks source link

Jupyter book #26

Open ppxasjsm opened 1 year ago

ppxasjsm commented 1 year ago

Maybe host content as jupyter-book:

https://jupyterbook.org/en/stable/start/your-first-book.html

This looks like a cool tool an other JOSE papers have also done this.

ppxasjsm commented 1 year ago

I've created a draft of a jupyter-book, which can be viewed in the _build directory. It basically just turned all notebooks into a static HTML page. If you open the https://github.com/Edinburgh-Chemistry-Teaching/Data-driven-chemistry/blob/main/_build/html/index.html locally you should be able to navigate the book.

We can host this as a GitHub pages along with the repo/paper and it can easily be updated if/when the notebooks get updated.

I haven't set up the github-pages yet, but it should be easily done.

punkpony commented 1 year ago

If you open the https://github.com/Edinburgh-Chemistry-Teaching/Data-driven-chemistry/blob/main/_build/html/index.html locally you should be able to navigate the book.

the link doesn't work:(

ppxasjsm commented 1 year ago

No I had to take it out of the repo. I had attached a zip to the email you can look at. Also not essential yet for the paper submission.

On 11 Jan 2023, at 17:09, Valentina Erastova @.**@.>> wrote:

This email was sent to you by someone outside the University. You should only click on links or attachments if you are certain that the email is genuine and the content is safe.

If you open the https://github.com/Edinburgh-Chemistry-Teaching/Data-driven-chemistry/blob/main/_build/html/index.html locally you should be able to navigate the book.

the link doesn't work:(

— Reply to this email directly, view it on GitHubhttps://github.com/Edinburgh-Chemistry-Teaching/Data-driven-chemistry/issues/26#issuecomment-1379193386, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AA37SXBXOW6O2OHEOKTPI2TWR3SMJANCNFSM6AAAAAATKS3LWY. You are receiving this because you authored the thread.Message ID: @.***>

Dr. Antonia Mey (she/her) FHEA Chancellor’s Fellow

If I send an email out-of-hours, I am doing so because it is convenient for me. Please respond at a time that is convenient for you.

Post: Room 214, School of Chemistry | David Brewster Road | University of Edinburgh | Edinburgh EH9 3FJ Tel: +44 131 651 3309 or via Teams | Email: @.**@.> | Web: mey-research.orghttp://mey-research.org

[cid:E1447FC1-9DC0-494B-A7E6-FC8803948168]

The University of Edinburgh is a charitable body, registered in Scotland, with registration number SC005336. Is e buidheann carthannais a th’ ann an Oilthigh Dhùn Èideann, clàraichte an Alba, àireamh clàraidh SC005336.

ppxasjsm commented 1 year ago

I've pushed this to gihub pages now: https://edinburgh-chemistry-teaching.github.io/Data-driven-chemistry/overview.html

I will look into building this automatically from the most recent set of files, but here to get an idea of what it looks like.

ppxasjsm commented 1 year ago

@punkpony, @jcumby, @degiacom and @clhobday if you see any issues in the way the notebooks are displayed in this book add them here and will fix try and fix the build. Will take a few days before I'll round to fixing anything though.

punkpony commented 1 year ago

neat! we just will need to make sure it is updated with the latest version

ppxasjsm commented 1 year ago

Yes, I think it can build automatically on every push! I have already spotted a couple of display issus so will look into.