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.0.0.tar.gz (26.6 MB view details)

Uploaded Source

Built Distribution

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

maxwellbloch-0.0.0-py3-none-any.whl (22.4 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for maxwellbloch-0.0.0.tar.gz
Algorithm Hash digest
SHA256 07553638cdb50b3a7697b4b75e9ef01010486828532c57ff98eec53efb3104bc
MD5 9d8b971cefd806bd0a41a2fc8e3636ec
BLAKE2b-256 870ab3cb61fc05889276a44fe02f205a9fb5ebc83ad76191505632beb10af881

See more details on using hashes here.

Provenance

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

File metadata

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

File hashes

Hashes for maxwellbloch-0.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0d602aed63c418b3a3b06da422fdd3a90070e715221338d19c9245b3daec1f5e
MD5 2056ee4eeaf4d77dbe1fe8cff7a6dc83
BLAKE2b-256 3ccaa532505fa722bf41b42111c6c8f7b689f054598fe6db27c0619981722967

See more details on using hashes here.

Provenance

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