solprop#

Ultrafast nonlinear pulse propagation.

solprop models ultrafast pulse propagation with the unidirectional pulse propagation equation (UPPE) and the generalised nonlinear Schrödinger equation (GNLSE), for the full electric field or a complex envelope, in one mode, in many modes of a waveguide and in radial or Cartesian free space. The manual is under docs/guide/ and the design under docs/dev/.

Every submodule is an attribute of the package, imported on first access (PEP 562), so dir(solprop) and tab completion list them while import solprop stays within its import-time budget: h5py, matplotlib and a compiled backend load only when used. The package installs a logging.NullHandler; call solprop.log.configure_logging() from a script to see progress and diagnostics.

Modules

adiabatic

Certify adiabatic forward transport through a real index that varies along z.

backends

Execution backends behind one seam.

boundaries

Absorbing boundaries as absorption rates per unit distance.

calibration

Calibrating the native backend to its machine (SEP 46).

capabilities

What solprop can do: for a route, a species and a results file (SEP 41, S8, S16).

cli

The solprop command line: run, resume, check and export recipes (SEP 41, S1).

constants

Physical constants in SI units.

coupling

Couple simulations through a coherent field at a reference plane (SEP 31).

driver

The simulation driver: physics objects in, a written run out.

exceptions

The exception and warning hierarchies.

fourier

Fourier conventions, transforms, oversampling and energy functionals.

gasflow

Steady gas flow in a hollow fibre: the fill, the choked end and the flow regime.

grid

Time, frequency and transverse grids for field-resolved and envelope propagation.

hankel

Transform an axisymmetric field with the raw order-zero QDHT.

linear

Assembly of the linear operator D(omega, z) of one mode at one z.

log

Logging and progress reporting.

modes

Waveguide modes: the protocol, the mode families, and the machinery behind them.

monitor

The boundary monitor: guard and collar occupancy, and the energy the collar removes.

noise

Shot-noise realisations: one photon per mode per frequency bin.

nonlinear

Nonlinear responses and their models (physics layer).

optics

Linear optical elements applied to a pulse outside a propagation.

output

Output handlers, the run record they write, and the files a run leaves.

physdata

Material data: gases, mixtures and solids, mostly from optmat (SEP 3).

plotting

Standard plots of propagation results with matplotlib.

polarisation

Construct Jones optics and describe transverse polarisation in the optics convention.

processing

Post-processing of saved runs, in the optics convention and in SI units.

profiles

Scalar paths along the propagation axis, with breakpoints and derivatives.

pulses

Initial pulses on either grid: shape, exact scaling and the user's spectral phase.

recipe

Recipes: a simulation written as a TOML document, built into a Simulation.

scan

Launch an explicitly selected scan script without evaluating CLI expressions.

service

The service between a front end and solprop: messages, kernel, runs, machines.

sol

The session namespace: everything a person types at a prompt, behind one import.

spatial

Describe bulk media, exact longitudinal propagation and spatial field measures.

spatial_absorber

The transverse boundary of a free-space run: its specification and its design.

stats

The catalogue of plane statistics, with one definition of each.

stepper

The step specifications a run carries, and the scalar algebra of every step.

tools

Design calculators: the numbers a person works out before a run.

translate

The translation layer: physics objects turned into the kernel problem a backend runs.

transverse_monitor

The boundary monitor's transverse edge (SEP 40 section 5.3).