Skip to main content

Symbolic normal (Wick) ordering involving bosonic ladder operators.

Project description

pyBoLaNO: A Python Symbolic Package for Normal Ordering Involving Bosonic Ladder Operators

boson-ladder-logo

Hello, there!

The pyBoLaNO package is fully based on the SymPy symbolic package and serves as a complement for its bosonic ladder operator features that have yet to be implemented.


Who needs this?

Are you tired of doing a cumbersome bosonic ladder operator algebra with complicated commutation relations and keep making mistakes in the page-long derivation but do not realize until you are at the end? We feel the same.


We present you...

At ver. 1.0.0, this package offers you useful functions to do your algebra, including:

  • Normal-ordering any polynomial of bosonic ladder operators.
  • Normal-ordering any commutator of two polynomials of bosonic ladder operators.
  • And this is what motivates us to do this: evaluating the normal ordering of any expectation value evolution equation for systems described in the Linbdlad Master Equation framework using bosonic ladder operators.

What's more, it works for multipartite systems!


Let's be transparent

The core working principle of pyBoLaNO is simple—the package is based on the commutation relations $\left[\hat{b}_j , \hat{b}_k^\dagger\right]= 1 \mathrm{if} j=k,\ 0 \mathrm{otherwise}$ and $\left[\hat{b}_j,\hat{b}_k\right]=\left[\hat{b}_j^\dagger,\hat{b}_k^\dagger\right]=0$ of the bosonic creation $\hat{b}_j^\dagger$ and annihilation $\hat{b}_j^\dagger$ operators, where the subscript ($j$ here) indexes the bosonic mode. More precisely, we make use of the explicit formula for the normal ordering of any monomial in bosonic operators presented by Blasiak (arXiv link for his PhD thesis and the journal article).

> normal_ordering

allows the user to normal-order any polynomial of bosonic ladder operators. It separates each monomial in the input (most generally a polynomial) by the subscripts of the ladder operators. For each subscript, normal ordering is performed using Blasiak's formulae (see Eqs. (4.2), (4.10), (4.34), (4.37) of his thesis linked above). Lastly, the algorithm moves the operators with different indices (which commute) around to give a nice-looking output.

> NO_commutator

allows the user to evaluate the any commutation relation of two polynomials of bosonic ladder operators. It is just a shorthand to save you the time of typing normal_ordering(A*B-B*A).

> LME_expval_evo

allows the user to compute the normal-ordered expression for the expectation value evolution of a quantity represented by the operator $\hat{A}$ for a system described in the Lindblad master equation framework. The user simply needs to input: (1) the Hamiltonian $\hat{H}$; (2) the Lindblad dissipator operators $\hat{O}_j,\hat{P}_j$ as well as their nonnegative multiplier $\gamma_j$; and (3) the operator $\hat{A}$ to calculate the expectation value evolution of.

Inside LME_expval_evo, the function Hamiltonian_trace is called to evaluate the contribution from the Hamiltonian, while dissipator_trace is called to evaluate the contribution from each dissipator term indexed $j$ above. These functions are available for the user to call, as well.


A quick guide

We provide a quick tutorial of this package, in the file tutorial.ipynb in the repository tree. Here is a quick link that will take you there. The notebook includes examples of use alongside a more detailed explanation of the way the package works.


Cite us, please!

Pitiful as it may be, researchers nowadays are valued based on their citation counts. If you find our package helpful for your work, feel free to acknowledge the use of pyBoLaNO in your publications. Here is a bibtex entry you can copy:

@article{hendlim2024,
    title = "pyBoLaNO: A Python Symbolic Package for Normal Ordering Involving Bosonic Ladder Operators",
    year = 2024,
    author = "Lim, Hendry M. and Dwiputra, Donny and Ukhtary, M. Shoufie and Nugraha, A. R. T"
}

Parting words

This program is far from perfect and we would appreciate any critics and suggestions that you may have. In particular, we would appreciate it if you could inform us of any bugs you encounter while using this package. Feel free to reach out to us via email to hendry01@ui.ac.id.

Enjoy the package. \( ゚ヮ゚)/

- The authors.



CHANGELOG

ver 1.0.0

  • First release.

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

pybolano-1.0.0.tar.gz (14.1 kB view details)

Uploaded Source

Built Distribution

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

pybolano-1.0.0-py3-none-any.whl (14.3 kB view details)

Uploaded Python 3

File details

Details for the file pybolano-1.0.0.tar.gz.

File metadata

  • Download URL: pybolano-1.0.0.tar.gz
  • Upload date:
  • Size: 14.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.3

File hashes

Hashes for pybolano-1.0.0.tar.gz
Algorithm Hash digest
SHA256 5aee48b89f1ba308913a8569ddffdb6d09288e929a9a915e4195513717bf39ec
MD5 4d6b0b55b384b883bb5540b34e888b5c
BLAKE2b-256 6c69bc291383481960acf0d2c969a8784cb0050e1fcd9af242b5c936136e27a8

See more details on using hashes here.

File details

Details for the file pybolano-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: pybolano-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 14.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.3

File hashes

Hashes for pybolano-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 afcbd675844d7b801a01a8161a87bc6c5f461c91459fd0e87ed1ccd973cf042f
MD5 9b147d583c29bb3e051d7d265f7ea5d0
BLAKE2b-256 11cc69d5a2c59c8aa2eaa0d3c34718d8e9ca77aaa86e1c05b00a1b700699e446

See more details on using hashes here.

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