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/.
Setting up and running:
driver(theprop_*entry points and scans),recipe,grid,pulses,profiles,gasflow,stepper,boundariesandnoise.The physics:
modes,nonlinear,physdata,linear,spatial,spatial_absorber,adiabatic,polarisation,fourier,hankelandconstants.Results:
output,processing,stats,monitorandtransverse_monitor,plotting,coupling,opticsand the design calculators oftools.Session and tooling:
sol(the interactive namespace),log,exceptions,cli,scan,capabilities,calibrationandservice.
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
Certify adiabatic forward transport through a real index that varies along z. |
|
Execution backends behind one seam. |
|
Absorbing boundaries as absorption rates per unit distance. |
|
Calibrating the native backend to its machine (SEP 46). |
|
What solprop can do: for a route, a species and a results file (SEP 41, S8, S16). |
|
The |
|
Physical constants in SI units. |
|
Couple simulations through a coherent field at a reference plane (SEP 31). |
|
The simulation driver: physics objects in, a written run out. |
|
The exception and warning hierarchies. |
|
Fourier conventions, transforms, oversampling and energy functionals. |
|
Steady gas flow in a hollow fibre: the fill, the choked end and the flow regime. |
|
Time, frequency and transverse grids for field-resolved and envelope propagation. |
|
Transform an axisymmetric field with the raw order-zero QDHT. |
|
Assembly of the linear operator |
|
Logging and progress reporting. |
|
Waveguide modes: the protocol, the mode families, and the machinery behind them. |
|
The boundary monitor: guard and collar occupancy, and the energy the collar removes. |
|
Shot-noise realisations: one photon per mode per frequency bin. |
|
Nonlinear responses and their models (physics layer). |
|
Linear optical elements applied to a pulse outside a propagation. |
|
Output handlers, the run record they write, and the files a run leaves. |
|
Material data: gases, mixtures and solids, mostly from optmat (SEP 3). |
|
Standard plots of propagation results with matplotlib. |
|
Construct Jones optics and describe transverse polarisation in the optics convention. |
|
Post-processing of saved runs, in the optics convention and in SI units. |
|
Scalar paths along the propagation axis, with breakpoints and derivatives. |
|
Initial pulses on either grid: shape, exact scaling and the user's spectral phase. |
|
Recipes: a simulation written as a TOML document, built into a |
|
Launch an explicitly selected scan script without evaluating CLI expressions. |
|
The service between a front end and solprop: messages, kernel, runs, machines. |
|
The session namespace: everything a person types at a prompt, behind one import. |
|
Describe bulk media, exact longitudinal propagation and spatial field measures. |
|
The transverse boundary of a free-space run: its specification and its design. |
|
The catalogue of plane statistics, with one definition of each. |
|
The step specifications a run carries, and the scalar algebra of every step. |
|
Design calculators: the numbers a person works out before a run. |
|
The translation layer: physics objects turned into the kernel problem a backend runs. |
|
The boundary monitor's transverse edge (SEP 40 section 5.3). |