qdk_chemistry.plugins.openfermion.qubit_mapper module

OpenFermion-based qubit mappers to map electronic structure Hamiltonians to qubit Hamiltonians.

This module provides an OpenFermionQubitMapper class to convert Hamiltonians to QubitHamiltonians using different mapping strategies (“jordan-wigner”, “bravyi-kitaev”, “symmetry-conserving-bravyi-kitaev”, and “bravyi-kitaev-tree”).

class qdk_chemistry.plugins.openfermion.qubit_mapper.OpenFermionQubitMapper(encoding='jordan-wigner')[source]

Bases: QubitMapper

Map an electronic structure Hamiltonian to a QubitHamiltonian using OpenFermion.

Available encodings:
  • "jordan-wigner" (default)

  • "bravyi-kitaev"

  • "symmetry-conserving-bravyi-kitaev" (requires Symmetries)

  • "bravyi-kitaev-tree"

Parameters:

encoding (str)

__init__(encoding='jordan-wigner')[source]

Initialize OpenFermionQubitMapper with a specific mapping strategy.

Parameters:

encoding (str) – Qubit mapping strategy. See Available encodings above.

name()[source]

Return the algorithm name openfermion.

Return type:

str

class qdk_chemistry.plugins.openfermion.qubit_mapper.OpenFermionQubitMapperSettings[source]

Bases: QubitMapperSettings

Settings configuration for an OpenFermionQubitMapper.

Inherits encoding from QubitMapperSettings.

Available encodings:
  • "jordan-wigner" (default)

  • "bravyi-kitaev"

  • "symmetry-conserving-bravyi-kitaev" (requires Symmetries)

  • "bravyi-kitaev-tree"

__init__()[source]

Initialize OpenFermionQubitMapperSettings.