Instructor guide#

While this is meant as internal documentation for the instructor, others are welcome to read it.

Adding/updating packages#

  1. Modify environment.yml

  2. Run

    ./extras/scripts/update_packages.sh

  3. Manually update the notebooks with interactivity

  4. Update environment in JupyterHub

    mamba env update --file extras/environment.lock.yml --prune

Slides#

While the lecture notes can be viewed as a plain notebook, they are also visible as slides.

Site#

The site is generated using JupyterBook and deployed to ReadTheDocs. Markdown (.md) files and the files and folders that start with an underscore (_) are related to JupyterBook.

  1. If not on the nyu branch, render the files. This will overwrite local files, and thus you should stage changes first.

    ./extras/scripts/school.sh <school>

  2. Build the site.

    ./extras/scripts/build.sh

You can then check broken links with

ruby ./extras/scripts/broken_links.rb

Notebook cleanup#

To ensure that notebooks have the correct execution order and output, run them non-interactively.

./extras/scripts/update.sh <file>.ipynb

Start of class checklist#

  • Zoom

    1. Start meeting

    2. From the podium PC, Join Meeting

    3. If there’s a guest, make them a co-host

    4. Ensure all the cameras are turned on

    5. On laptop, mute mic and speakers

    6. On Zoom Classroom, unmute mic

    7. Confirm audio being received in Zoom

    8. Share screen

    9. Start recording

  • Set placeholders

  • If first couple classes: take attendance for recording Academic Engagement

Data sets#

Canonical copies of data are in a Google Drive folder, synced locally with Google Drive for desktop. Data is then compressed and uploaded to a Google Cloud Storage bucket via Terraform. Descriptions of the data sets.