Examples#
This section contains hands-on, runnable examples from the repository’s
examples/ folder. Each example has its own page (linked below) with a
brief explanation, the script, instructions to run it, and suggestions for
modifications.
- Custom Backend (Minimal) Example
- General Example
- Backend Extensibility Example
- Bosonic Number Example
- Operator Cache & Wrapper Example
- Collapse Operators (Open Systems)
- Custom Subsystem Example
- IR Debugging and Inspection
- JAX Autodiff Workflow
- NumPy Backend Example
- Advanced Operator Functions
- Parameter Validation and Aliases
- QuTiP BRME DSL Example
- SCQubits Example
- Static Qubit Example
- Time-Dependent Drive Example
- QuTiP Notebook Example
Overview#
Each example page includes: a short description, the source (embedded via
literalinclude), run instructions, and notes on expected output.Examples are grouped by skill level; see the examples index for grouping.
Run examples locally#
From the project root run any example script, for example:
python examples/example_static_qubit.py
If you want to build the full docs locally and preview, run your usual Sphinx
build command (for example make html in the docs/ folder).