Edinburgh-Chemistry-Teaching/Data-driven-chemistry

Jupyter book

ppxasjsm opened this issue · 7 comments

ppxasjsm commented

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

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

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
ppxasjsm commented

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.

  • ❤️1
ppxasjsm commented

@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

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

ppxasjsm commented

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

  • 👍1