njurs / snowex2021

JupyterBook for SnowEx Hackweek 2021

SnowEx Hackweek 2021 JupyterBook Website

https://snowex-hackweek.github.io/website

Run tutorials on BinderHub

Run tutorials locally

First install Docker if you don't have it

git clone https://github.com/snowex-hackweek/website
cd website/book/tutorials
docker compose up

GitHub Deployment (changing book contents)

The repository comes with a preconfigured GitHub Actions script so that any commits to the main branch are deployed the the GitHub Pages hosted website.

Local Development (adding tutorials)

To add a tutorial as a jupyter notebook under ./book/tutorials, you'll want to use a consistent environment. The best approach for this is to use a Docker Image (this ensures tutorials run in the same environment whether it is your laptop, the event JupyterHub, or some other server):

git clone https://github.com/snowex-hackweek/website
cd website
docker run uwhackweek/snowex:2021.09.07 -v $PWD:/home/jovyan jb build book

About JupyterBook

https://jupyterbook.org

Contact

• Anthony Arendt
• Scott Henderson

Now I know how to update Github codes.