solprop.output#
Output handlers, the run record they write, and the files a run leaves.
The record of a run (layer S, imported by translation and the backends without the handlers):
records(the record types of a saved run and its planes),metadata(RunMetadataand the resume key),serialisation,provenance,store(the save protocol,Output, and field retention) andcapability(what a saved basis can be asked).The handlers:
memory(MemoryOutput),hdf5(HDF5Outputwithopen_file(),read_resume_state()andcheck_cache()) andcallback(CallbackOutput, for a run reduced plane by plane).The other files a run leaves:
tdse_archive(the raw TDSE response archive),snapshots(checkpoints published while a run computes),resumable(whether a file can continue), and a scan’s collected file and per-point artifacts (scan,scan_artifacts).
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
The output handler that gives each plane to a callable and keeps nothing. |
|
What a stored basis admits: the accessor gate of the run record. |
|
The streaming HDF5 output handler, with cache, resume and read-only reopening. |
|
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). |
|
A scan's collected HDF5 file, to which one controller commits completed points. |
|
A durable queue's per-point artifact files, written and read without any pickle. |
|
Serialisation of configuration objects into the JSON a run record stores. |
|
Immutable, verified checkpoints published 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). |