Focused demonstrations#

These runnable examples isolate a feature or modelling choice. For a paced first calculation, start with the introduction; for full comparisons and ensembles, use the worked examples. The user guide explains the models and their limitations.

Each page includes a downloadable Python script and notebook. Demonstrations execute during documentation builds, with unchanged results reused from the Sphinx-Gallery cache. Their size and runtime follow the physical question; a reduced calculation should not be treated as a convergence study.

Getting started#

A first run, the pulses a run starts from, reading and plotting a saved run, the interactive namespace, scans over parameters, how to inspect and compare the material models a run takes from optmat, and how to tell whether a time window is big enough.

Package overview

Package overview

A pulse on both grids

A pulse on both grids

Analysing a saved run

Analysing a saved run

An interactive session: design, run, compress

An interactive session: design, run, compress

Scan helium pressure and pulse energy

Scan helium pressure and pulse energy

Compare material choices

Compare material choices

Is my time window big enough?

Is my time window big enough?

Gas-filled capillaries#

Gas flow and mixtures in hollow capillaries, envelope plasma and vector Raman responses, the coherent wall that couples a capillary’s modes (on a straight bore, on a taper, and with the vector (TE/TM) wall), the low-call integrators and a frequency-dependent Kerr response.

For the soliton and dispersive-wave lessons, begin with the Introduction.

Gas flow in a hollow fibre: tapers, choked ends and the flow regime

Gas flow in a hollow fibre: tapers, choked ends and the flow regime

Separate nitrogen and oxygen ionisation in an air-filled capillary

Separate nitrogen and oxygen ionisation in an air-filled capillary

Compare a carrier-resolved pulse with envelope plasma

Compare a carrier-resolved pulse with envelope plasma

Follow vector Raman coherence with a delayed probe

Follow vector Raman coherence with a delayed probe

The coherent wall of a capillary, against the incoherent one

The coherent wall of a capillary, against the incoherent one

Mode conversion and loss in a taper with a coherent wall

Mode conversion and loss in a taper with a coherent wall

The vector wall: two impedances, two families, one conversion

The vector wall: two impedances, two families, one conversion

Fewer source calls: the two integrators

Fewer source calls: the two integrators

A frequency-dependent Kerr response

A frequency-dependent Kerr response

Waveguide models#

Antiresonant fibres, tabulated modes, step-index, graded-index and rectangular guides, the general modal route for guides that supply their own vector fields, a declared basis over a split pair, hollow planar guides per unit width, and a gas-filled hollow rectangular guide built from a supplied mode.

Propagate through a single-ring antiresonant fibre

Propagate through a single-ring antiresonant fibre

Use tabulated hollow and solid-core modes

Use tabulated hollow and solid-core modes

Explore exact step-index fibres and hollow rectangular guides

Explore exact step-index fibres and hollow rectangular guides

Inspect step-index and graded-index electric fields

Inspect step-index and graded-index electric fields

Propagate a vector fibre mode, and check it against the GNLSE

Propagate a vector fibre mode, and check it against the GNLSE

Self-imaging in a graded-index guide, and a launch declared as a field

Self-imaging in a graded-index guide, and a launch declared as a field

A declared basis of a split pair: two bases, one answer

A declared basis of a split pair: two bases, one answer

A hollow planar waveguide, per unit width

A hollow planar waveguide, per unit width

A gas-filled hollow rectangular waveguide

A gas-filled hollow rectangular waveguide

Free space#

Beams in radial and Cartesian geometries, a self-focusing diagnostic, a line beam uniform in one direction, a planar guide resolved across its width, a weak band calibrated under the low-storage march, a four-wave-mixing delay scan run through one backend with statistics-only planes, far-field spectra collected through apertures in a mask plane, a beam prepared by Kerr self-focusing in a gas gap and coupled into a capillary, a transverse window sized with the boundary monitor, and a radial beam under the Kerr effect built from plain objects.

For the full filament and crossing-beam lessons, begin with the Introduction.

Radial diffraction and a separate self-focusing diagnostic

Radial diffraction and a separate self-focusing diagnostic

A Cartesian beam in argon

A Cartesian beam in argon

A line beam: diffraction and the (1+1)-D Kerr soliton

A line beam: diffraction and the (1+1)-D Kerr soliton

A planar guide resolved in y

A planar guide resolved in y

Calibrating a weak band with the low-storage march

Calibrating a weak band with the low-storage march

A four-wave-mixing delay scan through one backend

A four-wave-mixing delay scan through one backend

Far-field spectra through apertures

Far-field spectra through apertures

Nonlinear beam preparation and coupling into a capillary

Nonlinear beam preparation and coupling into a capillary

Is my transverse window big enough?

Is my transverse window big enough?

A radially symmetric beam under the Kerr effect

A radially symmetric beam under the Kerr effect

Design and compression tools#

Grating and prism compressors: recovering the stage setting that compresses a chirped pulse.

Grating spacing and prism insertion

Grating spacing and prism insertion