solprop.output#
Output handlers and the metadata schema.
In-memory and HDF5 outputs sharing one save protocol
(solprop.output.store.PlaneStore), 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" (see docs/dev/decisions.md). The manual page is
docs/guide/results/output.md. A run reduced plane by plane stores nothing, and gives
each plane to a callable instead (CallbackOutput;
docs/guide/setup/running.md). A TDSE run can also write its raw provider
evaluations to a separate archive
(TDSEArchive, read with
open_tdse_archive();
docs/guide/media/tdse.md).
Modules
The output handler that gives each plane to a callable and keeps nothing. |
|
What a stored basis admits: the accessor whitelist of the run record. |
|
The streaming HDF5 output handler, with cache and resume. |
|
The in-memory output handler. |
|
The run record: what produced an output file, and the resume key it is checked by. |
|
What executed a run and which code it was: the backend, the git commit, the versions. |
|
The record types of a saved run: its grid, modes, noise, stepper and saved planes. |
|
Whether a results file can continue, rebuild itself, and pass the gate (SEP 41, S17). |
|
Commit independently completed points to one recoverable HDF5 scan file. |
|
Store durable queue results without loading Python objects from files. |
|
Serialisation of configuration objects into the JSON a run record stores. |
|
Publish immutable, verified checkpoints while a propagation stays alive. |
|
The one save protocol both output handlers implement, and the field retention. |
|
Archive every raw TDSE provider evaluation of a run in an HDF5 sidecar (SEP 20). |