Documentation

Each module carries its own documentation. This hub points you to per-package docs, tutorials, conventions and the things that keep the Toolkit reliable.

Per-module documentation

Every package documents itself on its own page — start from the catalogue and follow the Docs link on any card. Coverage varies by module and we’re continuously improving it; direct links to the Mathematica documentation for key modules are being added here.

Tutorials & talks

All talks from the 2020 virtual BHPToolkit workshop were recorded and are a great introduction for new users. Watch them on the BHPToolkit YouTube channel. Worked examples for the Mathematica modules live in the MathematicaToolkitExamples repository.

Reporting issues & suggesting features

We test the components carefully, but errors do slip through. Please report anything you think is wrong — or suggest new features — via the issue tracker on the relevant repository. See the issue tracker guide for how to file a useful report.

Reliability

Continuous integration

Packages are tested automatically on every change using GitHub Actions, so regressions are caught early. Current build status is on the unit test status page.

Naming conventions

We keep consistent naming across the Toolkit so functions and quantities mean the same thing everywhere. The current list is on the conventions page.

Workshops

Information on upcoming and previous workshops is on the workshops page.