:orphan:

..
   This page and its API reference children are intentionally kept out of the
   site's toctree: navigation points to the hosted API reference (see the
   "API reference" toctree in ``index.rst``). They are still built so the
   generated HTML is available in the Sphinx artifact for downstream ingestion.

########################################
``qiskit-fermions`` Python API reference
########################################

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

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

.. toctree::
   :maxdepth: 1

   qiskit_fermions.operators
   qiskit_fermions.operators.library
   qiskit_fermions.operators.terms


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

.. toctree::
   :maxdepth: 1

   qiskit_fermions.mappers
   qiskit_fermions.mappers.library
   qiskit_fermions.mappers.optimization


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

.. toctree::
   :maxdepth: 1

   qiskit_fermions.circuit
   qiskit_fermions.circuit.library


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

.. toctree::
   :maxdepth: 1

   qiskit_fermions.transpiler
   qiskit_fermions.transpiler.passes
   qiskit_fermions.transpiler.passes.plugins
   qiskit_fermions.transpiler.passes.utils
   qiskit_fermions.transpiler.presets


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

.. toctree::
   :maxdepth: 1

   qiskit_fermions.linalg


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

.. toctree::
   :maxdepth: 1

   qiskit_fermions.protocols


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

.. toctree::
   :maxdepth: 1

   qiskit_fermions.utils.optionals