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.C3	Class for calculating the C3 coefficient between two states.
perturbative.C6	Class for calculating the C6 coefficient for a two atom state |ket1, ket2>.
perturbative.EffectiveSystemPair	Class for creating an effective SystemPair object and calculating the effective Hamiltonian.