Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Course Creation Workflow

Below is a typical set of steps for creating a course that uses JupyterHub:

  1. Create a private GitHub repository for instructor notebooks that include solutions.

  2. Create a public GitHub repository for student-facing notebooks.

  3. Author your notebooks. The Resources and Screen Recordings section below lists two excellent resources to help you get started.

  4. Copy the student versions of the notebooks into the public repository.

  5. Choose a method for distributing notebooks to students:

    • Use nbgitpuller links to allow students to load each notebook directly (see the resources section for guidance).

    • Have students download notebooks from GitHub and upload them to the Hub manually.

  6. Optional: Upload datasets to the shared_readwrite folder of your institution’s hub if you are providing datasets specific to your course. This allows students to access them directly from the shared folder.

    • The shared folder is read-only and accessible to all students and instructors on a given JupyterHub. This allows users to access datasets from the hub instead of each user uploading the same dataset to their home folder.

    • The shared_readwrite folder is read and write and accessible to instructors.

    • If you need access to the shared_readwrite folder, please open an issue here.

    • More details about these folders can be found in the Materials Sharing section.

  7. Decide how students will submit their work. Most commonly, students download notebooks from the Hub and upload them to your LMS (e.g., Canvas) or a grading platform such as Gradescope.

Resources and Screen Recordings

Cal-ICOR Documentation
Getting Started
Cal-ICOR Documentation
Authentication