Skip to main content

logo

A fast and easy to use Gross-Pitaevskii equation solver.

Description

PyGPE is a CUDA-accelerated Python library for solving the Gross-Pitaevskii equations for use in simulating Bose-Einstein condensate systems.

Supported features

  • Scalar, two-component, spin-1, and spin-2 BEC systems.
  • 1D, 2D, and 3D grid lattices.
  • GPU support.
  • HDF5 data saving system.
  • Method for generating vortices within the system.

Requirements

  • Python (3.10 and above),
  • h5py (^3.6.0),
  • numpy (^2.0.0),
  • Matplotlib (^3.8.2)

If using a GPU:

  • CUDA Toolkit (>=11.2)
  • CuPy (>=10.2.0).

Installation

The simplest way to begin using PyGPE is through pip:

pip install pygpe

By default, PyGPE will use the CPU to perform calculations. However, if a CUDA-capable GPU is detected, PyGPE will automatically utilise it for drastic speed-ups in computation time.

Examples

See examples folder for various examples on the usage of the library. Below is an animation of superfluid turbulence in a scalar BEC simulated using PyGPE on a $512^2$ lattice for $N_t=200000$ time steps taking ~5 minutes to complete on an RTX 2060.

logo

Metadata

Release files for pygpe 2.0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pygpe 2.0.4
File Size Uploaded
pygpe-2.0.4.tar.gz 17.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pygpe 2.0.4
File Interpreter ABI Platform
pygpe-2.0.4-py3-none-any.whl Python 3 none any Details

Total release size: 43.5 kB

Release files / pygpe-2.0.4.tar.gz

Download URL pygpe-2.0.4.tar.gz
Size 17.0 kB
Tags Source
SHA-256 checksum
How to use checksums
24e6d3137bd28844eaf31cadd81c86101eb9902261d6455bd96765abcc4ae4c2
BLAKE2b-256 checksum
How to use checksums
b0e3ae2af394162f15086ee2ca12501509fe99a177aaabf6d44a4ddea31571d7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.5 CPython/3.12.1 Linux/6.8.0-1017-azure

Release files / pygpe-2.0.4-py3-none-any.whl

Download URL pygpe-2.0.4-py3-none-any.whl
Size 26.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
62647fc0866c523cdb5fe136417ce9110ae63b55b6b25716e9d97c7d99b0ecfc
BLAKE2b-256 checksum
How to use checksums
f0c7a3900c9fd3cd8ddcee806dbffc25b2d5ca52af4d1fe24cc9190142313938
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.5 CPython/3.12.1 Linux/6.8.0-1017-azure

Release history Release notifications | RSS feed

This release

2.0.4 This release

2 release files

2.0.3

2 release files

2.0.2

2 release files

2.0.1

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.3

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.2

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page