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.12.0.tar.gz (63.8 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.12.0-py3-none-any.whl (53.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for maxwellbloch-0.12.0.tar.gz
Algorithm Hash digest
SHA256 d8f6dd642893753f74f9cdbb10f995cd77a0d001bb1904ef05c8c0ac14b66c5f
MD5 7268845c505d6a6c6716a6855251817c
BLAKE2b-256 5a9c6bdef51424b000f8c91dbb8046f03064d472bc4d9eddfbee63f2cb1c433a

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: maxwellbloch-0.12.0-py3-none-any.whl
  • Upload date:
  • Size: 53.0 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.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f9b4e9bc4fe0502c9310e3ad4c83e8619bd821935b842cd12dbdbf03d6d3318b
MD5 9f86e418e4e6fb763c222410341e0e77
BLAKE2b-256 5216f35d8649048794a37733258fb53041537283761311092ae4fe0434b77616

See more details on using hashes here.

Provenance

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