Skip to content

Commit

Permalink
Improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sverhoeven committed Feb 13, 2024
1 parent 77a8cd2 commit 214f652
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions TEACH.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,27 @@ The grading setup is [one class, one grader](https://nbgrader.readthedocs.io/en/

In the SRC component

- Add `grader_user` parameter with username of person who will be grading.
- Add `grader_user` parameter with username of person who will be grading.
Use `==USERNAME==` as default value, which will be replaced by the actual username of the user creating the workspace.
This user will also be responsible for setting up the course and assignments.
- Add `students` parameter with list of student usernames and hashed passwords.
- Add `students` parameter with list of student usernames and passwords.
The value should be a JSON string in format of `[["username1", "password1"]]`.
The value can be generated by running [create_student_passwords.py](create_student_passwords.py) script with list of username (one on each line) as input.

In the SRC catalog item

- Expose `grader_user` and `student_users` as interactive parameters.

## SRC workspace creation

During creation you can set the `students` parameter to create local posix accounts for students.
The value for the `students` parameter can be generated by running [create_student_passwords.py](create_student_passwords.py) script with list of username (one on each line) as input. See docs in script for more details. The passwords generated by the script should be distributed to the students.

## Students

Students can be managed with [nbgrader labextension & cli](https://nbgrader.readthedocs.io/en/stable/user_guide/managing_the_database.html#managing-students)
Assigning students to courses can be managed with [nbgrader labextension & cli](https://nbgrader.readthedocs.io/en/stable/user_guide/managing_the_database.html#managing-students).

The student id is a posix username in the VM.
In a ewatercycle VM users can be added during workspace creation or with [Surf Research Access Management](https://sram.surf.nl/).
In a ewatercycle VM, users can be added during workspace creation or with [Surf Research Access Management](https://sram.surf.nl/).
After sram invite a cronjob will add the user to the VM. Login with totp as password.

## Create assignment
Expand Down

0 comments on commit 214f652

Please sign in to comment.