Tutorials

Start with Your first calculation, then use the CLI command reference or the desktop guide. Use Inputs and units when adapting an example to a new structure.

Notebook tutorials by Robert J. Steed

The four notebooks in tutorials/ explain the physical and numerical workflow. Their APIs and input formats predate the current GUI; adapt the notebook code to the current source where needed. They are not executed during documentation builds.

Notebook

Topic

Download

Tutorial 1

General usage

Notebook 1

Tutorial 2

Hybridising degenerate energy levels

Notebook 2

Tutorial 3

Parabolic potential structures

Notebook 3

Tutorial 4

Optical intersubband transitions

Notebook 4

The source notebook directory also provides GitHub previews. Local notebook use requires a Jupyter installation; it is not a runtime dependency of the simulator.