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

Example gallery¶

Every script here is run when the documentation is built, and the figures below are the ones it produced. Each page carries the source, so the code you read is the code that made the plot.

The benchmark sweeps run over a short range of grid sizes here, so the graph below is one this build drew; run them yourself and they cover the full range.

They are also drawn on the machine that built these pages, which is a GitHub runner with no GPU: it has the CPU backend and nothing else, so a comparison between backends has nothing to compare. Run them on your own hardware for that – the figures say which backends they found.

Two are listed with their source but not executed, because both exit early without what they need: profile_cupy.py wants a CUDA device, and juliaGPE_vs_NLSE.py wants timings from a benchmark run.

Benchmarking every backend

Benchmarking every backend

Many simulations at once

Many simulations at once

Sampling a run, and adapting its step

Sampling a run, and adapting its step

Two coupled components

Two coupled components

Two coupled components in one dimension

Two coupled components in one dimension

Driven-dissipative polaritons

Driven-dissipative polaritons

Backends compared

Backends compared

Counter-streaming beams go turbulent

Counter-streaming beams go turbulent

A Bose-Einstein condensate

A Bose-Einstein condensate

Jones-Roberts solitons

Jones-Roberts solitons

Against FourierGPE.jl

Against FourierGPE.jl

A Gaussian beam in a Kerr medium

A Gaussian beam in a Kerr medium

Three dimensions, with dispersion

Three dimensions, with dispersion

Propagation in one dimension

Propagation in one dimension

A non-local interaction

A non-local interaction

Profiling the CUDA backend

Profiling the CUDA backend

Rayleigh-Taylor instability

Rayleigh-Taylor instability

Spin and density modes

Spin and density modes

A precessing vortex pair, animated

A precessing vortex pair, animated

Vortex precession, timed across grid sizes

Vortex precession, timed across grid sizes

Vortex shedding past a mobile impurity

Vortex shedding past a mobile impurity

Gallery generated by Sphinx-Gallery

Next
Benchmarking every backend
Previous
Physical validation
Copyright © 2026, Tangui Aladjidi
Made with Sphinx and @pradyunsg's Furo