The package is available on the Python Package Index and can be installed using the following command.
pip install wave-packet-dynamicsThis package provides a framework for simulating the time evolution of a single wave packet in an arbitrary time-independent potential. Currently, only one-dimensional simulations are supported. Additionally, the package provides a simple interface for visualizing the results of the simulations.
The documentation is made with Material for MkDocs and is hosted by ReadTheDocs.
The project uses PDM as the package manager. After cloning the repository and installing PDM, run the following commands to create a virtual environment and install the development dependencies.
pdm venv create
pdm installAfterward, several useful commands for formatting, linting, testing and type checking are available.
pdm run --listThe project is distributed under the terms of the BSD-3-Clause license.