Nbgrader notes - Revision history

Pelibby16 at 21:00, 19 January 2026

2026-01-19T21:00:48Z

Pelibby16: Update class setup steps for nbgrader

2025-02-05T16:08:49Z

Update class setup steps for nbgrader

← Older revision		Revision as of 16:08, 5 February 2025
Line 21:		Line 21:
	== Beginning of Term Notes: Setting up a New Class ==		== Beginning of Term Notes: Setting up a New Class ==

	# ~~At least a week~~ before the term starts, send the admins (admin [at] cs [dot] earlham [dot] edu) the list of student names and email addresses so the admins can set up accounts for them.		# As soon as possible (hopefully before the term starts), send the admins (<code>admin [at] cs [dot] earlham [dot] edu</code>) the list of student names and email addresses so the admins can set up accounts for them.
	# Log in as nbgrader. From within the terminal, use ~~<code>nbgrader quickstart classname</code>~~ to create a new class, ~~where classname is~~ the name of the class (something like cs128-f21). Folders for cs128 classes are called cs128-f20 or cs128-s21, where f and s are "fall" and "spring" and the two digits are the year. This command will create a new folder for the class, plus a source folders and config file within it.		# Log in to <code>pollock.cs.earlham.edu</code> as nbgrader. From within the terminal, use the following command to create a new class, replacing "CLASSNAME" with the name of the class (something like cs128-f21). <br><code>nbgrader quickstart CLASSNAME</code><br>
			#:* Folders for cs128 classes are called '''cs128-f20''' or '''cs128-s21''', where f and s are "fall" and "spring" and the two digits are the year.
			#:* This command will create a new folder for the class, plus a source folders and config file within it.
	# Copy the contents of the source directory from last term�s course into the new directory's source directory (or whatever material from previous courses that you plan to use.) The source directory is where assignments are stored before they are released to students.		# Copy the contents of the source directory from last term�s course into the new directory's source directory (or whatever material from previous courses that you plan to use.) The source directory is where assignments are stored before they are released to students.
	# The config file at <code>~nbgrader/.jupyter/nbgrader_config.py</code> should be edited to update the two references to the old class so that they refer to the new class.		# The config file at <code>~nbgrader/.jupyter/nbgrader_config.py</code> should be edited to update the two references to the old class so that they refer to the new class:<br><pre># ~nbgrader/.jupyter/nbgrader_config.py c = get_config() c.CourseDirectory.root = "/mounts/pollock/nbgrader/CLASSNAME"</pre>
	# You may need to restart nbgrader�s server at this point. From the jupyter interface, select �Control Panel,� then �Stop My Server.� After a moment, you will be able to select �Start Server.�		# You may need to restart nbgrader�s server at this point. From the jupyter interface, select �Control Panel,� then �Stop My Server.� After a moment, you will be able to select �Start Server.�
	# Navigate to <code>/~~srv-- This~~ step .		# Navigate to <code>/usr/local/share<code>old/</code> directory.
			#:* This will prevent students from ever seeing the old labs (and possibly getting them by mistake, rather than getting the new labs.)
	##		#:* '''2025 Note''': Skipping this step leaves the previous semesters course available from the "assignments" dropdown on Jupyter.
			<br>
	# ~~Currently, the <code>student-names-file</code> file is used to build up the student db.~~ You can import names from the list using <code>nbgrader db student import student-names-file</code> The content in the <code>student-names-file</code> should follow the style required by nbgrader (the first line needs to be as follows, and the last line needs to be empty). If you generated student-names-file using the instructions in the previous steps, it should already look like this.		#:*
	~~## Line 1~~: <~~code~~>id,last_name,first_name, email~~</code>~~		# You can import names from the list using <code>nbgrader db student import student-names-file</code> The content in the <code>student-names-file</code> should follow the style required by nbgrader (the first line needs to be as follows, and the last line needs to be empty). If you generated student-names-file using the instructions in the previous steps, it should already look like this:<br><pre>id,last_name,first_name,email smaizaz18,Aizaz,Shah,smaizaz18@earlham.edu pelibby16,Libby,Porter,pelibby16@earlham.edu ...</pre>
	#~~# Line 2: <code>~~smaizaz18,Aizaz,Shah, smaizaz18@earlham.edu</~~code~~>		#:* You can use <code>nbgrader db student list</code> to check if the students has been added successfully
	# ~~(Optional)~~ You can use <code>nbgrader db student list</code> to check if the students has been added successfully		#:* .
	# ~~(Optional)~~		#:* '''2025 Note''': You need to run the move the student-names-file into the course directory and run the import command from there.
	# ''This step and the remaining steps may no longer be necessary.'' Copy the two feedback files, which have names like feedback-summer19.sh, and return_feedback-summer19.py, into the course directory for the new course.		# ''This step and the remaining steps may no longer be necessary.'' Copy the two feedback files, which have names like feedback-summer19.sh, and return_feedback-summer19.py, into the course directory for the new course.
	# Update the names of those two files to refer to the correct term.		# Update the names of those two files to refer to the correct term.

Minevig: Igor added a bullet point to the beginning of the list of things to do in the beginning of the term: send the list of student names and email addresses to the admins

2022-01-29T00:43:20Z

Igor added a bullet point to the beginning of the list of things to do in the beginning of the term: send the list of student names and email addresses to the admins

← Older revision		Revision as of 00:43, 29 January 2022
Line 21:		Line 21:
	== Beginning of Term Notes: Setting up a New Class ==		== Beginning of Term Notes: Setting up a New Class ==

			# At least a week before the term starts, send the admins (admin [at] cs [dot] earlham [dot] edu) the list of student names and email addresses so the admins can set up accounts for them.
	# Log in as nbgrader. From within the terminal, use <code>nbgrader quickstart classname</code> to create a new class, where classname is the name of the class (something like cs128-f21). Folders for cs128 classes are called cs128-f20 or cs128-s21, where f and s are "fall" and "spring" and the two digits are the year. This command will create a new folder for the class, plus a source folders and config file within it.		# Log in as nbgrader. From within the terminal, use <code>nbgrader quickstart classname</code> to create a new class, where classname is the name of the class (something like cs128-f21). Folders for cs128 classes are called cs128-f20 or cs128-s21, where f and s are "fall" and "spring" and the two digits are the year. This command will create a new folder for the class, plus a source folders and config file within it.
	# Copy the contents of the source directory from last term�s course into the new directory's source directory (or whatever material from previous courses that you plan to use.) The source directory is where assignments are stored before they are released to students.		# Copy the contents of the source directory from last term�s course into the new directory's source directory (or whatever material from previous courses that you plan to use.) The source directory is where assignments are stored before they are released to students.

Barbeda at 20:43, 5 August 2021

2021-08-05T20:43:38Z

← Older revision		Revision as of 20:43, 5 August 2021
Line 21:		Line 21:
	== Beginning of Term Notes: Setting up a New Class ==		== Beginning of Term Notes: Setting up a New Class ==

	# Log in as nbgrader. From within the terminal, use <code>nbgrader quickstart classname</code> to create a new class, where classname is the name of the class. Folders for cs128 classes are called cs128-f20 or cs128-s21, where f and s are "fall" and "spring" and the two digits are the year. This command will create a new folder for the class, plus a source folders and config file within it.		# Log in as nbgrader. From within the terminal, use <code>nbgrader quickstart classname</code> to create a new class, where classname is the name of the class (something like cs128-f21). Folders for cs128 classes are called cs128-f20 or cs128-s21, where f and s are "fall" and "spring" and the two digits are the year. This command will create a new folder for the class, plus a source folders and config file within it.
	# Copy the contents of the source directory from last term�s course into the new directory's source directory (or whatever material from previous courses that you plan to use.) The source directory is where assignments are stored before they are released to students.		# Copy the contents of the source directory from last term�s course into the new directory's source directory (or whatever material from previous courses that you plan to use.) The source directory is where assignments are stored before they are released to students.
	# The config file at <code>~nbgrader/.jupyter/nbgrader_config.py</code> should be edited to update the two references to the old class so that they refer to the new class.		# The config file at <code>~nbgrader/.jupyter/nbgrader_config.py</code> should be edited to update the two references to the old class so that they refer to the new class.

Barbeda: /* Releasing an Assignment */

2020-08-09T20:27:11Z

Releasing an Assignment

← Older revision		Revision as of 20:27, 9 August 2020
Line 40:		Line 40:

	== Managing Assignments ==		== Managing Assignments ==
			=== Preparing an Assignment ===
			# Assignments can be found in the source directory within the course directory.
			# Assignments should be updated before release - once an assignment is released, further changes to the source copy will not be reflected in the version that students get.

	=== Releasing an Assignment ===		=== Releasing an Assignment ===
	# Log in to the Jupyter web interface at tools.cs.earlham.edu as nbgrader.		# Log in to the Jupyter web interface at tools.cs.earlham.edu as nbgrader.
Line 46:		Line 50:
	# �Generate� => �Release�		# �Generate� => �Release�
	## Both of these should pop up log output boxes. Neither log output should contain errors, just information.		## Both of these should pop up log output boxes. Neither log output should contain errors, just information.

	===Student Work===		===Student Work===
	# Once an assignment has been released, students can access it.		# Once an assignment has been released, students can access it.

Barbeda: /* Beginning of Term Notes: Setting up a New Class */

2020-08-07T19:57:24Z

Beginning of Term Notes: Setting up a New Class

← Older revision		Revision as of 19:57, 7 August 2020
Line 21:		Line 21:
	== Beginning of Term Notes: Setting up a New Class ==		== Beginning of Term Notes: Setting up a New Class ==

	# Log in as nbgrader. From within the terminal, use <code>~~nbgrade~~ quickstart classname</code> to create a new class, where classname is the name of the class. Folders for cs128 classes are called cs128-f20 or cs128-s21, where f and s are "fall" and "spring" and the two digits are the year. This command will create a new folder for the class, plus a source folders and config file within it.		# Log in as nbgrader. From within the terminal, use <code>nbgrader quickstart classname</code> to create a new class, where classname is the name of the class. Folders for cs128 classes are called cs128-f20 or cs128-s21, where f and s are "fall" and "spring" and the two digits are the year. This command will create a new folder for the class, plus a source folders and config file within it.
	# Copy the contents of the source directory from last term�s course into the new directory's source directory (or whatever material from previous courses that you plan to use.) The source directory is where assignments are stored before they are released to students.		# Copy the contents of the source directory from last term�s course into the new directory's source directory (or whatever material from previous courses that you plan to use.) The source directory is where assignments are stored before they are released to students.
	# The config file at <code>~nbgrader/.jupyter/nbgrader_config.py</code> should be edited to update the two references to the old class so that they refer to the new class.		# The config file at <code>~nbgrader/.jupyter/nbgrader_config.py</code> should be edited to update the two references to the old class so that they refer to the new class.

Barbeda at 19:52, 30 July 2020

2020-07-30T19:52:49Z

@@ Line 18: / Line 18: @@
 * [[Nbgrader notes/tools]]
 * [[Nbgrader notes/Weekly setup]]
 == Upgrading nbgrader ==
@@ Line 92: / Line 148: @@
 <code>gb.remove_student("syweiss15")</code>  <ref>https://nbgrader.readthedocs.io/en/stable/api/gradebook.html</ref>

Barbeda: /* Returning feedback to students */

2020-07-30T19:52:09Z

Returning feedback to students

@@ Line 38: / Line 38: @@
 * [https://github.com/jupyter/nbgrader/pull/563/files Ability to switch between courses in assignment list extension #563]
 ** Needs to be added manually until it gets merged into <code>nbgrader master</code>.
 == Multiple Simultaneous Graders ==

Barbeda: /* Collecting and grading an assignment */

2020-07-30T19:51:56Z

Collecting and grading an assignment

@@ Line 38: / Line 38: @@
 * [https://github.com/jupyter/nbgrader/pull/563/files Ability to switch between courses in assignment list extension #563]
 ** Needs to be added manually until it gets merged into <code>nbgrader master</code>.
 == Returning feedback to students ==

Barbeda: /* Assigning Assignments */

2020-07-30T19:51:47Z

Assigning Assignments

@@ Line 38: / Line 38: @@
 * [https://github.com/jupyter/nbgrader/pull/563/files Ability to switch between courses in assignment list extension #563]
 ** Needs to be added manually until it gets merged into <code>nbgrader master</code>.
 == Collecting and grading an assignment ==