Note on the structure of the package

Note

The package QuantNBody is structured into 3 subpackages quantnbody.fermionic, quantnbody.bosonic, and quantnbody.hybrid_fermionic_bosonic, which are respectively dedicated to fermionic, bosonic, and fermionic-bosonic hybrid systems. Each subpackage contains a list of functions (encapsulated in a local tools module) that one can use for creating/manipulating many-body operators/wavefunctions. In practice, to access all the functions, one only needs to import the following modules:

For fermionic systems

>>> import quantnbody.fermionic.tools

For bosonic systems

>>> import quantnbody.bosonic.tools

For fermionic-bosonic hybrid systems

>>> import quantnbody.hybrid_fermionic_bosonic.tools

In the following, we detail the list of relevant callable functions for each type of many-body system.