solprop.driver#

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

Layer D of docs/dev/architecture.md section 3. The package re-exports Simulation (simulation, a run that translates once and writes a resumable file), SimulationSettings (settings), run_problem (run, the loop over save planes), SimulationRunner (runner), the keyword interfaces prop_gnlse, prop_capillary, prop_waveguide, prop_free and prop_planar (interface), and the TDSE presets and consistency check (tdse, tdse_consistency). The constructors’ keyword routes are solprop.driver.routes; scans and their executors are solprop.driver.scan and solprop.driver.executors; the session’s service loop, inputs, defaults, metadata, resume, summary and estimate have a module each. solprop.driver.scaffold stays as the independent fixed-step integrator the backend tests cross-check against. The manual page is docs/guide/setup/running.md.

Modules

defaults

The route defaults: one table, and the pure functions that resolve a default.

estimate

What a run will cost, before it runs (SEP 41, S11).

executors

Execute independent scan points under an explicit resource policy.

inputs

A run's input: its pulse, its launch, its shot noise and its peak field.

interface

The keyword interface: one call from keywords to a written run.

material_output

Record the material and physical reconstruction data needed by saved-run analysis.

metadata

The record that says what produced a run, and whether it may be resumed.

mixtures

Resolve material declarations and population selections at the driver boundary.

plane_view

The lazy view of a saved plane that a plane observer is shown (SEP 41, S3).

resume

Continue a run from the file it wrote: the resume decision and the restart.

routes

The keyword routes that build a solprop.driver.simulation.Simulation.

run

The outer loop of a run: save planes in, saved planes out.

runner

Run one translated simulation many times on one backend, input by input.

scaffold

A fixed-step interaction-picture integrator for the mode-averaged GNLSE.

scan

Describe indexed parameter scans and dispatch independent simulations.

session_loop

The session loop: Python's side of an execution session (SEP 47 section 5).

settings

How a run is stepped, what it records and which backend executes it.

simulation

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

summary

The block a run shows before its first step: what is about to be computed, and how.

tdse

Own the optional TDSE runtime behind the provider-free response seam.

tdse_consistency

Check a haCC model's weak-field linear response against optmat's helium (SEP 20).

tdse_run

The run glue of a TDSE response (SEP 20): its archive, atomic state and gate.