Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
NLSE 4.1.0
NLSE 4.1.0

Getting Started

  • Installation
  • Quick Start

User Guide

  • Physics Background
  • Solvers Overview
  • Backends
  • Callbacks
  • Numerical Methods
  • Physical validation
  • Example gallery
    • Benchmarking every backend
    • Many simulations at once
    • Sampling a run, and adapting its step
    • Two coupled components
    • Two coupled components in one dimension
    • Driven-dissipative polaritons
    • Backends compared
    • Counter-streaming beams go turbulent
    • A Bose-Einstein condensate
    • Jones-Roberts solitons
    • Against FourierGPE.jl
    • A Gaussian beam in a Kerr medium
    • Three dimensions, with dispersion
    • Propagation in one dimension
    • A non-local interaction
    • Profiling the CUDA backend
    • Rayleigh-Taylor instability
    • Spin and density modes
    • A precessing vortex pair, animated
    • Vortex precession, timed across grid sizes
    • Vortex shedding past a mobile impurity

Tutorial

  • NLSE for the gifted amateur

Reference

  • Migrating to 4.0.0
  • Changelog
  • Contributing

Development

  • Optimization log
  • Planned: examples from the literature
  • API Reference
    • NLSE
      • NLSE.backends
        • NLSE.backends.backend
        • NLSE.backends.benchmark
        • NLSE.backends.cpu
        • NLSE.backends.cupy_backend
        • NLSE.backends.mlx_backend
        • NLSE.backends.opencl
      • NLSE.callbacks
      • NLSE.solvers
        • NLSE.solvers.cnlse
        • NLSE.solvers.cnlse_1d
        • NLSE.solvers.ddgpe
        • NLSE.solvers.gpe
        • NLSE.solvers.nlse
        • NLSE.solvers.nlse_1d
        • NLSE.solvers.nlse_3d
        • NLSE.solvers.parameter
        • NLSE.solvers.step_size
      • NLSE.utils
Back to top
View this page
Edit this page

API ReferenceΒΆ

This page contains auto-generated API reference documentation [1].

  • NLSE
    • NLSE.backends
      • NLSE.backends.backend
      • NLSE.backends.benchmark
      • NLSE.backends.cpu
      • NLSE.backends.cupy_backend
      • NLSE.backends.mlx_backend
      • NLSE.backends.opencl
    • NLSE.callbacks
    • NLSE.solvers
      • NLSE.solvers.cnlse
      • NLSE.solvers.cnlse_1d
      • NLSE.solvers.ddgpe
      • NLSE.solvers.gpe
      • NLSE.solvers.nlse
      • NLSE.solvers.nlse_1d
      • NLSE.solvers.nlse_3d
      • NLSE.solvers.parameter
      • NLSE.solvers.step_size
    • NLSE.utils
[1]

Created with sphinx-autoapi

Next
NLSE
Previous
Planned: examples from the literature
Copyright © 2026, Tangui Aladjidi
Made with Sphinx and @pradyunsg's Furo