########################################
``qiskit-bosons`` Python API reference
########################################

.. meta::
   :description: Reference for the Python API of qiskit-bosons, covering operators, mappers,
                 circuits, the transpiler, linear algebra, protocols, and utilities.

..
    _Each page listed below sets its own `.. meta:: :description:`, which becomes its entry in
    `llms.txt`. When you add a module page, or change what a module provides, update that
    description. See `docs/README.md`, section "LLM-friendly output".

This is the reference for the Python API of the ``qiskit-bosons`` package.

*********
Operators
*********

.. toctree::
   :maxdepth: 1

   qiskit_bosons.operators
   qiskit_bosons.operators.library
   qiskit_bosons.operators.terms


*******
Mappers
*******

.. toctree::
   :maxdepth: 1

   qiskit_bosons.mappers
   qiskit_bosons.mappers.library


********
Circuits
********

.. toctree::
   :maxdepth: 1

   qiskit_bosons.circuit
   qiskit_bosons.circuit.library
   qiskit_bosons.circuit.library.synthesis


**********
Transpiler
**********

.. toctree::
   :maxdepth: 1

   qiskit_bosons.transpiler
   qiskit_bosons.transpiler.passes
   qiskit_bosons.transpiler.passes.synthesis
   qiskit_bosons.transpiler.passes.utils
   qiskit_bosons.transpiler.presets


**************
Linear Algebra
**************

.. toctree::
   :maxdepth: 1

   qiskit_bosons.linalg


*********
Protocols
*********

.. toctree::
   :maxdepth: 1

   qiskit_bosons.protocols


*********
Utilities
*********

.. toctree::
   :maxdepth: 1