This README is a quickstart. See the full documentation for more details.

The ibei python module implements a calculation of the upper-incomplete Bose-Einstein integral which is given in terms of the polylogarithm function and described by Smith.

This package is installable via pip.

pip install ibei

Alternatively, download the source, install hatch, and build.

git clone [email protected]:jrsmith3/ibei.git
pip install hatch
hatch build
pip install dist/ibei-1.0.6.tar.gz  # Or whatever is the latest version in that directory.

Calculate the number of above-bandgap photons from Si at 300K.

>>> import ibei
>>> bandgap = 1.1
>>> bei = ibei.BEI(order=2, energy_bound=bandgap, temperature=300., chemical_potential=0.)
<Quantity 10549124.09538381 1 / (m2 s)>

MIT

Full documenation can be found in the doc directory, at the official documentation page, and within the module's docstrings.