Welcome to nbchkr’s documentation!

A lightweight solution to mark/grade/check notebook assignments.

This documentation is in four parts:

• A tutorial: a step by step walk through of writing an assignment, using nbchkr to create a version to be released and checking submissions.
• A how to guide: a collection of short and to the point instructions for carrying out specific tasks.
• A series of explanations: some background information on nbchkr.
• A reference section: includes bibliography, a changelog and viewable source code.

Contents:

• Tutorial
  • Installing nbchkr
  • Writing an assignment
  • Releasing an assignment
  • Releasing solutions
  • Checking student assignments and generating feedback
• How to:
  • install
  • write a source assignment
  • release an assignment
  • solve an assignment
  • check a submission
  • handle a submission in the wrong format
  • contribute
  • release
• Explanation
  • why use nbchkr?
  • why use automated checking?
• Reference
  • Bibliography
  • Changelog
  • Source code