Metadata-Version: 2.4
Name: matterwave
Version: 0.5.2
Summary: A library for matter wave propagation built on top of fftarray.
Project-URL: Homepage, https://github.com/QSTheory/matterwave
Project-URL: Documentation, https://qstheory.github.io/matterwave/main
Project-URL: Repository, https://github.com/QSTheory/matterwave
Project-URL: Issues, https://github.com/QSTheory/matterwave/issues
Project-URL: Changelog, https://qstheory.github.io/matterwave/main/changelog.html
Author: Stefan Seckmeyer, Gabriel Müller, Christian Struckmann
License-File: LICENSE
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: fftarray>=0.5
Requires-Dist: numpy>=2.0
Requires-Dist: scipy
Description-Content-Type: text/markdown

# Matterwave

[**Intro**](#intro) | [**Installation**](#installation) | [**Documentation**](https://qstheory.github.io/matterwave/main/) | [**FFTArray Preprint (arXiv)**](https://arxiv.org/abs/2508.03697) | [**Change log**](https://qstheory.github.io/matterwave/main/changelog.html)

This library is a collection of routines and constants to help building simulations in the field of matter wave optics built on top of the [FFTArray](https://github.com/QSTheory/fftarray) library.
See also the [documentation](https://qstheory.github.io/matterwave/main/) of matterwave.

## Intro

The main features of matterwave include:
- A second-order split-step implementation for normal and imaginary time propagation.
- Functions for treating `fftarray.Array` instances as quantum mechanical wave functions, for example normalization, scalar product, expectation values and energy computation.
- Some helpful constants, currently only for the D2 line of Rb87.
- Some plotting helpers for the [panel](https://panel.holoviz.org/) library.

## Installation
For most use cases we recommend installing the optional constraint solver of FFTArray for easy Dimension definition with the `dimsolver` option:
```shell
pip install matterwave fftarray[dimsolver]
```
