Notebook Title

Authors: author 1, author 2, …

Go back to index

Source code: In this section a link to the source code on OSSCAR’s main GitHub repository is provided. This adheres to the open science principle of sharing all code as open source. Furthermore, this encourages advanced users to look into the code.

https://github.com/osscar-org/quantum-mechanics/blob/master/notebook/course_section/notebook_title.ipynb

Here, some short description is given to introduce the topic of the notebook.


Goals

A concise bulletpoint list of goals aids in directing the students’ focus and guiding their usage of the notebook.

  • Goal 1

  • Goal 2

  • Goal 3

Background theory

To streamline the user experience, a link is provided to a separate notebook that provides more detail on the background theory underlying the topic of the notebook. The notebook should be included in the theory subdirectory of the current directory and called theory_notebook_title.ipynb. More in the background theory.

Tasks and exercises

_Add here a list of tasks for the students to complete (typically between 2-6 tasks). The purpose of these tasks is primarily to provide direction for the students’ usage of the interactive components of the notebook rather than constituting fully-fledged assessment.

Solutions are also provided, which additionally allows the notebooks to be used offline either as a take-home exercise or for revision. Solutions should be sufficiently detailed for this purpose but may refer to external material to remain as concise as possible. The solutions are initially hidden - this has been shown to improve the effectiveness of learning by encouraging students to consider their responses before looking at the answers._

  1. Task 1
    Solution Solution for task one.
  2. Task 2
    Solution Solution for task two.
  3. Task 3
    Solution Solution for task 3.
  4. Task 4
    Solution Solution for task 4.

Interactive visualization

(be patient, it might take a few seconds to load) This is the core section of the notebook and contains all plots, widgets and interactive components.

# include plots and figures here

Legend

(How to use the interactive visualization)

Interactive figures

Here a description of what each of the different visualization components show is given to aid in usage of the notebook during and after a lesson.

Controls

A breakdown of how the various input parameters of the notebook can be tuned is provided. For example, “slider A allows modification of parameter A”, etc.