PyGPE documentation#

Version: 2.0.0

PyGPE is a Python library for simulating the dynamics of Bose-Einstein condensate systems in 1D, 2D and 3D. It offers an intuitive Wavefunction class for managing and manipulating the wavefunction of the system. What’s more, the evolution of the Gross-Pitaevskii equations is handled using CuPy, making PyGPE extremely fast at simulating dynamics. PyGPE currently supports scalar, two-component, spin-1 and spin-2 systems.

Getting started

Check out the starter guide for getting to grips with the basic use cases of PyGPE.

API Reference

See the API reference for detailed descriptions of the classes and functions contained in PyGPE.