Examples#

Use these calculations to explore a physical process, learn a particular interface, or adapt a complete simulation to your experiment. Each gallery page provides its Python source and a notebook download.

Start with a complete workflow#

The introduction leads from installation to propagation and analysis. Its learning sequence covers a multimode dispersive wave, an N = 3 soliton, a radial filament, and Cartesian free space. Use that sequence if you are new to solprop.

Introductory lesson	Main question
Dispersive-wave propagation	How do I run and analyse a multimode capillary calculation?
N = 3 soliton	How do soliton order, compression and recurrence relate?
Radial filament	How do self-focusing and plasma appear in the output?
Crossing beams	How do I launch custom arrays and interpret coherent interference?

Find an example by subject#

Subject	Focused demonstrations	Worked simulations
Pulse propagation and nonlinear processes	Capillary tutorials	Nonlinear processes: compression, dispersive waves, mixing, Raman, and ionisation
Supercontinuum and noise	Input pulses and their shot-noise floor	Supercontinuum generation: mechanisms, ensembles, noise, and coherence
Waveguide geometry	Waveguide tutorials	Waveguide physics: gradients, tapers, vector modes, and planar compressors
Beams and free space	Free-space tutorials: radial, Cartesian, line, and planar calculations	Follow their links to the free-space guide for model and resolution choices
Performance	Choosing a backend	Performance: single precision on an Apple GPU against binary64
Inputs, analysis, and workflows	Basics and optical tools	Use the analysis in a worked simulation as a starting point for your own output

Two kinds of calculation#

Focused demonstrations isolate a feature or a modelling choice. Some use reduced resolution to make the calculation easy to inspect; read their stated limitations before using the parameters for quantitative work.

Worked simulations follow a problem from setup to interpretation at its full propagation length. They can take substantially longer to run. Their pages include stored figures and the runtime and backend of the recorded calculation.

Use the user guide for the assumptions, detailed equations, and convergence checks behind an example, and the API reference for individual arguments.