stilt.output.Output.read#

Output.read(kind, variant, receptor_id, realization=None, columns=None)[source]#

Return one receptor’s result file as a table of its stored columns.

The file as written, with no date column: what table() reads for many receptors at once, for one. table() builds a dataset over its files, which costs more than this on a single one, so a method that reads receptors one at a time uses this.

Parameters:

  • kind (Literal['particles', 'footprints']) – Which result.

  • variant (Variant) – Whose result.

  • receptor_id (str) – The receptor, whose file must exist (present()).

  • realization (int | None) – Which realization of an ensemble.

  • columns (list[str] | None) – Only these stored columns. Every column by default.

Raises:

FileNotFoundError – If the receptor has no file, or the variant no folder.

Return type:

Table