Skip to content

Documentation

Manuals & guides

The Sphinx documentation is the reference. Everything below links straight to it, or to the runnable examples on GitHub.

Where to start

The reading order: install, then a tutorial end to end, then the task-oriented guides, then the API reference — with the runnable examples alongside. Install pip, then CMake Tutorials 3 walkthroughs How-to guides 24 tasks API reference every public name Examples 0 runnable scripts on GitHub

Resources

Runnable end-to-end scripts — every algorithm, backend and basis family has one, with its output committed alongside it.

Something wrong?

Bugs, wrong energies and backend mismatches belong in the issue tracker. Include the script, the basis, mapping and backend you ran with, and the version banner printed at the start of the run.

Open an issue (opens in a new tab)