solprop.output#

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

Every handler shares one save protocol, one metadata schema and one sign convention on the way out: stored fields are in the optics convention and carry the attribute spectral_convention = "optics" (docs/dev/conventions.md §2, ADR-017). The manual page is docs/guide/results/output.md. The package’s names are imported on first use (PEP 562), so that importing a record module does not load h5py or the handlers.

Modules

callback

The output handler that gives each plane to a callable and keeps nothing.

capability

What a stored basis admits: the accessor gate of the run record.

hdf5

The streaming HDF5 output handler, with cache, resume and read-only reopening.

memory

The in-memory output handler.

metadata

The run record: what produced an output file, and the resume key it is checked by.

provenance

What executed a run and which code it was: the backend, the git commit, the versions.

records

The record types of a saved run: its grid, modes, noise, stepper and saved planes.

resumable

Whether a results file can continue, rebuild itself, and pass the gate (SEP 41, S17).

scan

A scan's collected HDF5 file, to which one controller commits completed points.

scan_artifacts

A durable queue's per-point artifact files, written and read without any pickle.

serialisation

Serialisation of configuration objects into the JSON a run record stores.

snapshots

Immutable, verified checkpoints published while a propagation stays alive.

store

The one save protocol both output handlers implement, and the field retention.

tdse_archive

Archive every raw TDSE provider evaluation of a run in an HDF5 sidecar (SEP 20).