--- title: Qiskit bosons API documentation (latest version) description: Index of all the modules in the latest version of qiskit-bosons. source: https://quantum.cloud.ibm.com/docs/en/api/qiskit-bosons --- # `qiskit-bosons` Python API reference This is the reference for the Python API of the `qiskit-bosons` package. ## Operators - [Operator Representations](/docs/api/qiskit-bosons/operators) - [Operator Library](/docs/api/qiskit-bosons/operators-library) - [Operator Terms](/docs/api/qiskit-bosons/operators-terms) ## Mappers - [Representation Mappers](/docs/api/qiskit-bosons/mappers) - [Mapper Library](/docs/api/qiskit-bosons/mappers-library) ## Circuits - [Circuit Representation](/docs/api/qiskit-bosons/circuit) - [Circuit Library](/docs/api/qiskit-bosons/circuit-library) - [Circuit Library Synthesis (`B2B`)](/docs/api/qiskit-bosons/circuit-library-synthesis) ## Transpiler - [Transpiler](/docs/api/qiskit-bosons/transpiler) - [Transpiler Passes](/docs/api/qiskit-bosons/transpiler-passes) - [Transpiler Pass Synthesis (`B2Q`)](/docs/api/qiskit-bosons/transpiler-passes-synthesis) - [Transpiler Pass Utilities](/docs/api/qiskit-bosons/transpiler-passes-utils) - [Transpiler Presets](/docs/api/qiskit-bosons/transpiler-presets) ## Linear Algebra - [Linear Algebra Utilities](/docs/api/qiskit-bosons/linalg) ## Protocols - [Protocols](/docs/api/qiskit-bosons/protocols) ## Utilities ## Contents - [API index](/docs/api/qiskit-bosons) - [Release notes](/docs/api/qiskit-bosons/release-notes) - qiskit_bosons.circuit - [Module overview](/docs/api/qiskit-bosons/circuit) - [BosonicCircuit](/docs/api/qiskit-bosons/circuit-bosonic-circuit) - [BosonicDAGCircuit](/docs/api/qiskit-bosons/circuit-bosonic-dag-circuit) - [BosonicGate](/docs/api/qiskit-bosons/circuit-bosonic-gate) - [BosonicMode](/docs/api/qiskit-bosons/circuit-bosonic-mode) - [BosonicRegister](/docs/api/qiskit-bosons/circuit-bosonic-register) - [BosonicSpecifier](/docs/api/qiskit-bosons/circuit-bosonic-specifier) - qiskit_bosons.circuit.library - [Module overview](/docs/api/qiskit-bosons/circuit-library) - [Evolution](/docs/api/qiskit-bosons/circuit-library-evolution) - [InitializeModes](/docs/api/qiskit-bosons/circuit-library-initialize-modes) - [ModeRotation](/docs/api/qiskit-bosons/circuit-library-mode-rotation) - qiskit_bosons.circuit.library.synthesis - [Module overview](/docs/api/qiskit-bosons/circuit-library-synthesis) - [B2BSynthesisPlugin](/docs/api/qiskit-bosons/circuit-library-synthesis-b-2-b-synthesis-plugin) - [B2BSynthesisPluginManager](/docs/api/qiskit-bosons/circuit-library-synthesis-b-2-b-synthesis-plugin-manager) - [BosonicClementsDecomposition](/docs/api/qiskit-bosons/circuit-library-synthesis-bosonic-clements-decomposition) - [BosonicLieTrotter](/docs/api/qiskit-bosons/circuit-library-synthesis-bosonic-lie-trotter) - [BosonicQDrift](/docs/api/qiskit-bosons/circuit-library-synthesis-bosonic-q-drift) - [BosonicSuzukiTrotter](/docs/api/qiskit-bosons/circuit-library-synthesis-bosonic-suzuki-trotter) - [QDriftSampler](/docs/api/qiskit-bosons/circuit-library-synthesis-q-drift-sampler) - qiskit_bosons.linalg - [Module overview](/docs/api/qiskit-bosons/linalg) - [givens_decomposition](/docs/api/qiskit-bosons/linalg-givens-decomposition) - qiskit_bosons.mappers - [Module overview](/docs/api/qiskit-bosons/mappers) - [LevelEncoding](/docs/api/qiskit-bosons/mappers-level-encoding) - [LevelSpec](/docs/api/qiskit-bosons/mappers-level-spec) - [map_boson_action_generators](/docs/api/qiskit-bosons/mappers-map-boson-action-generators) - qiskit_bosons.mappers.library - [Module overview](/docs/api/qiskit-bosons/mappers-library) - [occupation_encoding](/docs/api/qiskit-bosons/mappers-library-occupation-encoding) - qiskit_bosons.operators - [Module overview](/docs/api/qiskit-bosons/operators) - [ann](/docs/api/qiskit-bosons/operators-ann) - [BosonAction](/docs/api/qiskit-bosons/operators-boson-action-boson-action) - [BosonOperator](/docs/api/qiskit-bosons/operators-boson-operator) - [cre](/docs/api/qiskit-bosons/operators-cre) - [OperatorTrait](/docs/api/qiskit-bosons/operators-operator-trait) - qiskit_bosons.operators.library - [Module overview](/docs/api/qiskit-bosons/operators-library) - [anti_commutator](/docs/api/qiskit-bosons/operators-library-anti-commutator) - [commutator](/docs/api/qiskit-bosons/operators-library-commutator) - [double_commutator](/docs/api/qiskit-bosons/operators-library-double-commutator) - [momentum](/docs/api/qiskit-bosons/operators-library-momentum) - [position](/docs/api/qiskit-bosons/operators-library-position) - qiskit_bosons.operators.terms - [Module overview](/docs/api/qiskit-bosons/operators-terms) - [canonical_order](/docs/api/qiskit-bosons/operators-terms-canonical-order) - [filter_diagonal_terms](/docs/api/qiskit-bosons/operators-terms-filter-diagonal-terms) - [group_coeff_means](/docs/api/qiskit-bosons/operators-terms-group-coeff-means) - [group_order](/docs/api/qiskit-bosons/operators-terms-group-order) - [groups_are_hermitian](/docs/api/qiskit-bosons/operators-terms-groups-are-hermitian) - [groups_have_uniform_coeffs](/docs/api/qiskit-bosons/operators-terms-groups-have-uniform-coeffs) - [order_terms](/docs/api/qiskit-bosons/operators-terms-order-terms) - qiskit_bosons.protocols - [Module overview](/docs/api/qiskit-bosons/protocols) - [SupportsCommutators](/docs/api/qiskit-bosons/protocols-supports-commutators) - qiskit_bosons.transpiler - [Module overview](/docs/api/qiskit-bosons/transpiler) - [B2QLayout](/docs/api/qiskit-bosons/transpiler-b-2-q-layout) - [BosonicCircuitToDAG](/docs/api/qiskit-bosons/transpiler-bosonic-circuit-to-dag) - [BosonicDAGToCircuit](/docs/api/qiskit-bosons/transpiler-bosonic-dag-to-circuit) - [BosonicPassManager](/docs/api/qiskit-bosons/transpiler-bosonic-pass-manager) - [QuantumDAGToCircuit](/docs/api/qiskit-bosons/transpiler-quantum-dag-to-circuit) - qiskit_bosons.transpiler.passes - [Module overview](/docs/api/qiskit-bosons/transpiler-passes) - [B2BSynthesis](/docs/api/qiskit-bosons/transpiler-passes-b-2-b-synthesis) - [B2BSynthesisConfig](/docs/api/qiskit-bosons/transpiler-passes-optimization-b-2-b-synthesis-b-2-b-synthesis-config) - [B2QSynthesis](/docs/api/qiskit-bosons/transpiler-passes-b-2-q-synthesis) - [CustomB2QLayout](/docs/api/qiskit-bosons/transpiler-passes-custom-b-2-q-layout) - [MergeEvolutions](/docs/api/qiskit-bosons/transpiler-passes-merge-evolutions) - [OccupationB2QLayout](/docs/api/qiskit-bosons/transpiler-passes-occupation-b-2-q-layout) - [RelabelModes](/docs/api/qiskit-bosons/transpiler-passes-relabel-modes) - qiskit_bosons.transpiler.passes.synthesis - [Module overview](/docs/api/qiskit-bosons/transpiler-passes-synthesis) - [B2QSynthesisConfig](/docs/api/qiskit-bosons/transpiler-passes-synthesis-b-2-q-synthesis-b-2-q-synthesis-config) - [B2QSynthesisPlugin](/docs/api/qiskit-bosons/transpiler-passes-synthesis-b-2-q-synthesis-plugin) - [B2QSynthesisPluginManager](/docs/api/qiskit-bosons/transpiler-passes-synthesis-b-2-q-synthesis-plugin-manager) - [group_wise](/docs/api/qiskit-bosons/transpiler-passes-synthesis-group-wise) - [MapperFnEvolutionSynthesis](/docs/api/qiskit-bosons/transpiler-passes-synthesis-mapper-fn-evolution-synthesis) - [OccupationInitializeModesSynthesis](/docs/api/qiskit-bosons/transpiler-passes-synthesis-occupation-initialize-modes-synthesis) - [simplify](/docs/api/qiskit-bosons/transpiler-passes-synthesis-simplify) - qiskit_bosons.transpiler.passes.utils - [Module overview](/docs/api/qiskit-bosons/transpiler-passes-utils) - [map_node_single_register](/docs/api/qiskit-bosons/transpiler-passes-utils-map-node-single-register) - qiskit_bosons.transpiler.presets - [Module overview](/docs/api/qiskit-bosons/transpiler-presets) - [generate_preset_occupation_pass_manager](/docs/api/qiskit-bosons/transpiler-presets-generate-preset-occupation-pass-manager)