PyGPE API Reference

Release:

2.0.0

Date:

Jan 14, 2024

This API reference details all the functions, modules and objects included in PyGPE, describing what they are and what they do.

• The Grid class
  • pygpe.shared.grid.Grid
• Condensate and time parameters
  • Scalar dictionary
  • Two-component dictionary
  • Spin-1 dictionary
  • Spin-2 dictionary
• Wavefunction
  • Scalar BEC wavefunction
  • Two-component BEC wavefunction
  • Spin-1 BEC wavefunction
  • Spin-2 BEC wavefunction
• Evolution functions
  • Scalar BEC evolution functions
  • Two-component BEC evolution functions
  • Spin-1 BEC evolution functions
  • Spin-2 BEC evolution functions
• The DataManager class
  • Scalar BEC DataManager
  • Two-component BEC DataManager
  • Spin-1 BEC DataManager
  • Spin-2 BEC DataManager
• Vortices
  • pygpe.shared.vortices.vortex_phase_profile