User guide#

This guide explains how to build a propagation model, run it, and assess the result. It covers waveguides and free space, the material responses that act on a pulse, and the numerical methods used to evolve it.

If this is your first simulation, begin with the introduction. Then read the guide in the order below, or start with the chapter for your geometry. Detailed equations, conventions, and approximation limits are part of these chapters; the API reference gives the precise arguments of each function.

To…	Start with…
Choose a model, input pulse, and computational window	Setting up a simulation
Propagate in a capillary, optical fibre, or another guide	Waveguide propagation
Model a beam, focus, or filament in a bulk medium	Free-space propagation
Choose the material and nonlinear processes	Materials and nonlinear responses
Check whether a calculation is resolved	Numerical methods and accuracy
Read, plot, and interpret a saved run	Results and interpretation
Design a configuration, compress a pulse, or scan parameters	Design and workflows
Select a backend or tune a large calculation	Backends and performance

Each section links to examples that put the models to use. When comparing a simulation with an experiment, read both the physical assumptions of its model and the numerical checks needed to resolve it. A small integration tolerance does not establish that the time window, bandwidth, or spatial basis is adequate.