API Reference

The pairinteraction package provides a Python interface for easily accessing the functionality in a pythonic way. This Python interface can be accessed via the pairinteraction module by importing

import pairinteraction.real as pi

Alternatively, the same functionality can be accessed using complex data types via import pairinteraction.complex as pi. The two submodules are completely identical in their functionality, but only differ in the data type they use.

All the available classes, methods and functions are documented below:

Database

Database

Class for a handling the databases for the pairinteraction package.

Single Atom

KetAtom

Ket for an atomic basis state.

BasisAtom

Basis for a single atom.

SystemAtom

System of a single atom.

Pair of Atoms

KetPair

Ket for a pair state of two atoms.

BasisPair

Basis for a pair of atoms.

SystemPair

System of a pair of atoms.

GreenTensor

Green tensor for the multipole pair interactions.

Convenience Functions

diagonalize(systems[, diagonalizer, ...])

Diagonalize a list of systems in parallel using the C++ backend.

Perturbative Calculations

perturbative.get_c3_from_system(...[, unit])

Calculate the \(C_3\) coefficient for a list of two 2-tuples of single atom ket states.

perturbative.get_c6_from_system(ket_tuple, ...)

Calculate the \(C_6\) coefficient for a given tuple of ket states.

perturbative.get_effective_hamiltonian_from_system(...)

Get the perturbative Hamiltonian at a desired order in Rayleigh-Schrödinger perturbation theory.