Skip to main content

ibei - Calculator for incomplete Bose-Einstein integral

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

Scope

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.

Installation

This package is installable via pip.

pip install ibei

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

git clone git@github.com: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.

Example

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)>

License

MIT

Documentation

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

Metadata

Release files for ibei 2.0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ibei 2.0.4
File Size Uploaded
ibei-2.0.4.tar.gz 44.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ibei 2.0.4
File Interpreter ABI Platform
ibei-2.0.4-py3-none-any.whl Python 3 none any Details

Total release size: 51.6 kB

Release files / ibei-2.0.4.tar.gz

Download URL ibei-2.0.4.tar.gz
Size 44.3 kB
Tags Source
SHA-256 checksum
How to use checksums
91c4cc56e7efae4d603ea51aab7fe7c1edcc48b192811435b630bc8eed3f62b5
BLAKE2b-256 checksum
How to use checksums
9a0721806ee788ed65329f80abac59a8f8d8b59e2c3577c62c0cf4c5756afa01
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 16, 2025.

Transparency log

Release files / ibei-2.0.4-py3-none-any.whl

Download URL ibei-2.0.4-py3-none-any.whl
Size 7.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cdac00966b0fd918fdcd838e59ac14e997a101bb432a153295c7914eae146e94
BLAKE2b-256 checksum
How to use checksums
ba0ccebb04c52b70db2cc9817351d548c63852096807be683d6e0438c26a3fe4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 16, 2025.

Transparency log

Release history Release notifications | RSS feed

This release

2.0.4 This release

2 release files

2.0.3

2 release files

2.0.2

2 release files

2.0.1

2 release files

2.0.0

1 release file

1.0.5

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page