File Structure of JupyterHub
When you first log in to your JupyterHub, you will notice a file browser on the left-hand side of the window. The directories displayed here are 'lectures' and 'shared'.
- Shared: The 'shared' directory is visible to both instructors and students. Instructors have both write and read access, while students have read-only access and the ability to copy its contents to their 'home' directory. This feature is handy for sharing study materials, like notebooks, that you'd like your students to access or explore, even if they aren't part of a specific assignment.
- Lectures: The 'lectures' directory contains separate directories for all lectures you are part of.
When you open a specific lecture directory, the following sub directories will be created by interacting with the Grader Service:
Instructor Directories:
- Source: Here you can find all source files that you added to an assignment.
- Release: Release directory is created automatically based on your source directory and contains notebooks in so called 'student view', representing how notebooks will look like, when students open them.
- Manualgrade: When you pull students' submissions, you can manually grade them from this location.
- Student Directories
- Assignments: Whenever you fetch an assignment, such as when you pull from a remote source, updated files will appear here.
- Feedback: When a submission is graded and feedback was generated, feedback files will be pulled in this directory.
Using JupyterHub for sharing study materials with students
Adding files to 'shared' directory
If you have study materials for your students that you want to make accessible within JupyterHub, where they can edit, view, or download them locally, you can do so as follows:
- Navigate to 'shared' directory in File Browser on your left-hand side:
2. Choose the desired lecture. If you are an instructor for multiple lectures, all of them will be listed. Please ensure that you select the correct one for which you intend to upload study materials. In our example, it will be 'jaas3.0'.
3. At this point, you have the option to add the desired files directly or create a folder to organize where the files should be stored. Please note that everything added to the shared directory is accessible to students. You can create files and directories directly from JupyterHub with a simple right-click.
Another way to achieve the same functionality is by simply dragging and dropping the desired files or directories from your computer. To illustrate, we have added two Python notebooks and a directory named 'Lecture-Notes'. Both the files and the 'Lecture-Notes' directory, along with their contents, are now visible to the students. We recommend creating a dedicated directory within the 'shared' directory for sharing your study materials. You can name it 'Lecture-Notes,' 'Study Materials,' or 'Lehrmaterialien' to keep your File Browser organized. Within this directory, you can further create subdirectories to organize your standalone materials. This lecture scripture directory will be automatically synced into the user's home directory to give them editing permissions.
How can students access shared files
To access study materials, students should also navigate to the 'shared' directory inside the File Browser. There, they can view shared materials or download them to their local machines. However, they cannot edit them within JupyterHub. If they wish to experiment with the materials and add their own functionalities, they can copy the materials to their 'home' directory, as shown in the example below:
Grader Service
If you are not familiar with Grader Service and unsure how to use it to grade assignments in your lectures, we encourage you to refer to our official Grader Service Documentation and Instructor Guide. The Instructor Guide offers valuable insights and instructions to help you create your first assignments, add and edit notebooks to them, and finally, grade them.