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.8.1.tar.gz (48.6 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.8.1-py3-none-any.whl (76.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for maxwellbloch-0.8.1.tar.gz
Algorithm Hash digest
SHA256 1fc3d4f2ad6e2d5cd1a1581cf846002ee21dade20acd0c586ee87b9f37c7dd67
MD5 b474acf0a900ea53bf58dc47407a4e69
BLAKE2b-256 96b7ed7044a843c79fcfcf2a79731edb4f9586da8318dde7d4cb7799a6e69286

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: maxwellbloch-0.8.1-py3-none-any.whl
  • Upload date:
  • Size: 76.6 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.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 94ca0fb87223c85824895f7a1800c74a49d47d308c4cf28d99628a16a5949bc3
MD5 f8cd412f47c30551092144af218479d2
BLAKE2b-256 b1fdddf27e8e1672e30964bc406e96ec59ab39f6e8c660a80e6ccdd05297dacb

See more details on using hashes here.

Provenance

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