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

.. meta::
   :description: Reference for the Python API of qiskit-fermions, 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-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
   qiskit_fermions.circuit.library.synthesis


**********
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