tstore.archive package

Subpackages

• tstore.archive.attributes package
  • Submodules
  • tstore.archive.attributes.dask module
  • tstore.archive.attributes.geopandas module
    • read_geometry()
  • tstore.archive.attributes.pandas module
    • read_attributes()
    • write_attributes()
  • tstore.archive.attributes.polars module
  • tstore.archive.attributes.pyarrow module
    • get_tstore_ids_filters()
    • read_attributes()
  • Module contents
• tstore.archive.metadata package
  • Submodules
  • tstore.archive.metadata.readers module
    • read_tstore_metadata()
  • tstore.archive.metadata.writers module
    • write_tstore_metadata()
  • Module contents
• tstore.archive.ts package
  • Subpackages
    • tstore.archive.ts.readers package
      • Submodules
      • tstore.archive.ts.readers.dask module
      • tstore.archive.ts.readers.polars module
      • tstore.archive.ts.readers.pyarrow module
      • Module contents
    • tstore.archive.ts.writers package
      • Submodules
      • tstore.archive.ts.writers.pyarrow module
      • Module contents
  • Submodules
  • tstore.archive.ts.utility module
    • get_time_filters()
  • Module contents

Submodules

tstore.archive.checks module

Created on Mon Jun 12 21:32:37 2023.

@author: ghiggi

tstore.archive.checks.check_is_tstore(base_dir)

Check is a TStore.

tstore.archive.checks.check_start_end_time(start_time, end_time)

Check start_time and end_time validity.

tstore.archive.checks.check_time(time)

Check time validity.

It returns a datetime.datetime object.

Parameters:

time ((datetime.datetime, datetime.date, np.datetime64, str)) – Time object. Accepted types: datetime.datetime, datetime.date, np.datetime64, str If string type, it expects the isoformat ‘YYYY-MM-DD hh:mm:ss’.

Returns:

time – datetime.datetime object.

Return type:

datetime.datetime

tstore.archive.checks.check_ts_variables(ts_variables, base_dir)

Check valid ts_variables.

If None, return all the available ts_variables.

tstore.archive.checks.check_tstore_ids(tstore_ids, base_dir)

Check valid tstore_ids.

If tstore_ids=None, return None.

tstore.archive.checks.get_available_ts_variables(base_dir)

Get available TStore timeseries.

tstore.archive.io module

TStore I/O tools.

tstore.archive.io.check_tstore_directory(base_dir, overwrite)

Check TStore directory.

tstore.archive.io.check_tstore_structure(tstore_structure)

Check validity of TStore structure.

tstore.archive.io.define_attributes_filepath(base_dir)

Define filepath of TStore attributes.

tstore.archive.io.define_metadata_filepath(base_dir)

Define TStore metadata filepath.

tstore.archive.io.define_tsarray_filepath(base_dir, tstore_id, ts_variable, tstore_structure)

Define filepath of a TStore TS.

tstore.archive.io.get_id_var(base_dir)

Get TStore ID variable.

tstore.archive.io.get_partitions(base_dir, ts_variable)

Get TStore time series partitioning.

tstore.archive.io.get_ts_info(base_dir, ts_variable)

Retrieve filepaths and tstore_ids for a specific ts_variable.

tstore.archive.io.get_tstore_structure(base_dir)

Get TStore structure.

tstore.archive.partitions module

Created on Mon Apr 8 17:05:26 2024.

@author: ghiggi

tstore.archive.partitions.add_partitioning_columns(df, partitioning_str, time_var, backend)

Add partitioning columns to the dataframe based on the partitioning string.

tstore.archive.partitions.check_partitioning(partitioning, ts_variables)

Check to_tstore partitioning values.

tstore.archive.partitions.check_partitions(partitioning_str)

Check partitioning components of partitinoning string.

Return the partitioning components.

tstore.archive.partitions.get_datetime_properties(df, time_var)

Get datetime properties from time column or index.

tstore.archive.partitions.get_partitioning_mapping_dict(time_var, backend='pandas')

Get partitioning mapping dict.

tstore.archive.partitions.get_valid_partitions()

Get valid partitioning components.

Module contents

Created on Mon Jun 12 22:23:06 2023.

@author: ghiggi