uataq.instruments.Instrument.read_data

Instrument.read_data(group, lvl=None, time_range=None, num_processes=1, file_pattern=None)

Read and parse data files for the given level and time range.

Uses multiple processes if specified.

Parameters:

• group (str) – The research group whose data to read.

• lvl (str | None) – The level of the data to read.

• time_range (TimeRange | str | tuple[str | datetime | datetime64 | None, str | datetime | datetime64 | None] | list[str | datetime | datetime64 | None] | slice | None) – The time range to read data. Default is None which reads all available data.

• num_processes (int | Literal['max']) – The number of processes to use for parallelization.

• file_pattern (str | None) – A string pattern to filter the file paths.

Returns:

A concatenated DataFrame containing the parsed data from files.

Return type:

DataFrame

Raises:

• ValueError – If lvl is not one of the data levels in uataq.filesystem.lvls.

• ReaderError – If the group has no such level for the instrument (the message says which levels it has), or no file is in the time range.