File Store

FileStore class grants access through your own time series data files. Right now, you can have your time series data files in 3 formats, ZRXP, CSV and Pickle.

class kisters.water.time_series.file_io.FileStore(root_dir: str, file_format: kisters.water.time_series.file_io.time_series_format.TimeSeriesFormat)

FileStore provides a TimeSeriesStore for your local time series data files

Parameters:
  • root_dir – The path to your time series data folder.
  • file_format – The format used by your time series data files.

Examples

from kisters.water.time_series.file_io import FileStore, ZRXPFormat
fs = FileStore('tests/data', ZRXPFormat())
ts = fs.get_by_path('validation/inner_consistency1/station1/H')
class kisters.water.time_series.file_io.CSVFormat(delimiter: str = ', ', quotechar: str = '"', header_lines: int = 1)

CSV formatter class

Example

from kisters.water.time_series.file_io import FileStore, CSVFormat
fs = FileStore('tests/data', CSVFormat())
class kisters.water.time_series.file_io.PickleFormat

Pickle formatter class

Example

from kisters.water.time_series.file_io import FileStore, PickleFormat
fs = FileStore('tests/data', PickleFormat())
class kisters.water.time_series.file_io.ZRXPFormat

ZRXP formatter class

Example

from kisters.water.time_series.file_io import FileStore, ZRXPFormat
fs = FileStore('tests/data', ZRXPFormat())