Skip to main content

A Python package for solving the Maxwell-Bloch equations.

Project description

MaxwellBloch

Build Status Documentation Status Coverage Status PyPI

MaxwellBloch is a Python package for solving the coupled Maxwell-Bloch equations describing the nonlinear propagation of near-resonant light through thermal quantised systems such as atomic vapours.

Above is an example solution for the propagation of a 4π pulse through a dense atomic vapour. The pulse immediately breaks up on entering the medium and the resultant pulses form two optical solitons each with a pulse area of 2π.

Documentation

Docs for the project are at maxwellbloch.readthedocs.io.

Install

The recommended way to install is via uv:

uv pip install maxwellbloch

Or using pip:

pip install maxwellbloch

If you prefer Conda, you can create and activate an environment with the required dependencies with

conda create --name mb -c conda-forge python=3.11 qutip
conda activate mb
pip install maxwellbloch

More detailed installation instructions can be found in the docs along with many example problems.

Attribution

If you use MaxwellBloch for research, please use the following citation:

@misc{ogden2020maxwellbloch,
  author = {Ogden, Thomas P.},
  title = {{MaxwellBloch}: a Python package for solving the coupled 
    Maxwell-Bloch equations describing the nonlinear propagation of 
    near-resonant light through thermal quantised systems such as atomic 
    vapors.},
  year = {2020},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/tpogden/maxwellbloch}}
}

Changelog

See CHANGELOG.md.

License

MIT License. See LICENSE.txt.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

maxwellbloch-0.10.0.tar.gz (49.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

maxwellbloch-0.10.0-py3-none-any.whl (41.2 kB view details)

Uploaded Python 3

File details

Details for the file maxwellbloch-0.10.0.tar.gz.

File metadata

  • Download URL: maxwellbloch-0.10.0.tar.gz
  • Upload date:
  • Size: 49.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for maxwellbloch-0.10.0.tar.gz
Algorithm Hash digest
SHA256 595530cac0a7d04b5c52222dc05ee56683b3da6d8f1db32375c94f5d62abbaad
MD5 9a983c7da14f633ea79d9d9b0368676a
BLAKE2b-256 48ec91eac976b21851fbc20498ffcd4b27f5ee9937d88bf91fcec841d7f07a30

See more details on using hashes here.

Provenance

The following attestation bundles were made for maxwellbloch-0.10.0.tar.gz:

Publisher: publish.yml on tpogden/maxwellbloch

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file maxwellbloch-0.10.0-py3-none-any.whl.

File metadata

  • Download URL: maxwellbloch-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 41.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for maxwellbloch-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a79e094c7be839913c6eb40fea18c63104913146022e55f67c7b295440d34421
MD5 359c11ff5ecf6f98dae6f46ad92db87f
BLAKE2b-256 9539eec2079737a16be7686c60605fcb7fa9f0d79c5408db273ea4239b263a31

See more details on using hashes here.

Provenance

The following attestation bundles were made for maxwellbloch-0.10.0-py3-none-any.whl:

Publisher: publish.yml on tpogden/maxwellbloch

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page