This the JupyterBook content for the PACE Hackweek 2024.
This repo is the source for our website: https://pacehackweek.github.io/pace-2024/. Go check it out!
- Fork or clone the pace-2024, pace-2024-tutorials, oceandata-notebooks repos.
- When tutorials are ready to be moved into the Jupyter Book, source the function in
copy_tutorials.py
and then use it to create the unrendered (tutorial repo) and rendered notebooks (book). - This will create a branch for you to work on.
- Switch to that branch and edit
book/_toc.yml
andbook/tutorials/index.md
. Commit those changes to the branch. - If there are any images that were created and that you need in the tutorial, then you will need to commit those and push.
- Create a PR and label the PR
preview
. A link to click to create the PR will be shown. - After you create the PR (with label
preview
, a link to a netlify preview will appear. Check to ensure that it looks good. - Troubleshooting
- Do you need to change the original tutorial and it is in the gfdl org? Go there and make changes. Then rerun the function in
copy_tutorials.py
. - Do you want to add files specific to the hackweek? You can add those, to the pace-2024 repo.
- Do you need to change the original tutorial and it is in the gfdl org? Go there and make changes. Then rerun the function in
- Once the PR looks good in netlify, it can be merged.
OR
- Clone the oceandata-noteboooks in an adjacent directory, and follow README instructions to build. (
jb build src/
) - Copy updates to the executed notebooks from the src/_build folder of the oceandata-notebooks repo to the book in this repo.
rsync -a ../oceandata-notebooks/src/_build/jupyter_execute/notebooks/hackweek/ book/presentations/hackweek/
- Commit the executed notebooks in this repo, and push to a PR tagged with
preview
.
- Make the necessary changes.
- Create a PR and label the PR
preview
. - A link to a netlify preview will appear. Check to ensure that it looks good and make any necessary changes.
- Once the PR is reviewed by another team member, it can be merged.
This is a clone of the eScience template repository designed to streamline creating two linked websites for a UW eScience Hackweek.
Please see the eScience repository template for usage, contributors and citation information.