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

I recommend using Conda environments.

You can create and activate an environment named mb with all the required dependencies for MaxwellBloch with

conda create --name mb -c conda-forge python=3 numpy=1 scipy=1 qutip=4
conda activate mb

The MaxwellBloch package can then be installed from PyPI using

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.0.tar.gz (45.2 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.0-py3-none-any.whl (72.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: maxwellbloch-0.8.0.tar.gz
  • Upload date:
  • Size: 45.2 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.0.tar.gz
Algorithm Hash digest
SHA256 ccd5735c5721cec7aac523e6ea709dc72d5a6f54b2740bac7e95719e75056813
MD5 89552653b695b9deb587cc16d5196e5e
BLAKE2b-256 dca6a2fad755d4ea230a4ccf285e32a734fb07a2da881863cdee639063aa7009

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: maxwellbloch-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 72.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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 41a416efafd662c246ac1d92fff1c66c1f2e963b6fe1d78e21fd9a1914762c55
MD5 d2b9c3e158322c14a2d4d4c285778d9b
BLAKE2b-256 b042562f8cfcaf84e2a4639b03d2a84b865d1db2a104e91013177ada6550536d

See more details on using hashes here.

Provenance

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