OM-Fish HackWeek JupyterBook

OM-Fish HackWeek 2027: A hackweek focused on Ocean Models for Fisheries and Ocean Ecosystems

Developers

New or updated tutorials

The following is out of date

1. Fork or clone the repo.
2. 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).
3. This will create a branch for you to work on.
4. Switch to that branch and edit book/_toc.yml and book/tutorials/index.md. Commit those changes to the branch.
5. If there are any images that were created and that you need in the tutorial, then you will need to commit those and push.
6. Create a PR and label the PR preview. A link to click to create the PR will be shown.
7. After you create the PR (with label preview, a link to a netlify preview will appear. Check to ensure that it looks good.
8. 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.
9. Once the PR looks good in netlify, it can be merged.

OR

1. Clone the repo locally and use jb build src/

Updating other parts of the Jupyter Book

2. Make the necessary changes.
3. Create a PR and label the PR preview.
4. A link to a netlify preview will appear. Check to ensure that it looks good and make any necessary changes.
5. Once the PR is reviewed by another team member, it can be merged.

Template courtesy of (by permission) eScience University of Washington

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.