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.11.0.tar.gz (61.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.11.0-py3-none-any.whl (50.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: maxwellbloch-0.11.0.tar.gz
  • Upload date:
  • Size: 61.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.11.0.tar.gz
Algorithm Hash digest
SHA256 055bbe7a513b8264907a0a21250c98c64522d8904381a0a50fe8220f9cf3556b
MD5 cac664490e6fc13f803c68bbf1cbf27e
BLAKE2b-256 b8f5007f30df53fc35746fdd3a76672917e819113408767fde6638b29c68d67e

See more details on using hashes here.

Provenance

The following attestation bundles were made for maxwellbloch-0.11.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.11.0-py3-none-any.whl.

File metadata

  • Download URL: maxwellbloch-0.11.0-py3-none-any.whl
  • Upload date:
  • Size: 50.5 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.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5cd4c7b6249653b9d7aba8980b9d11caa805e9fc43bc1d403ffd9a36171e1bd7
MD5 30255cc3f73a05a47db39ed01159cc89
BLAKE2b-256 a4ba5b2eb36b5d459fc81876ad1e50a065dec038d4e66d4ab441a81279b9299d

See more details on using hashes here.

Provenance

The following attestation bundles were made for maxwellbloch-0.11.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