Tsdat¶
Tsdat is an open-source Python framework that makes creating pipelines to process and standardize time-series data more easy, clear, and quick to stand up so that you can spend less time data-wrangling and more time on data analysis.
Table of Contents¶
- About
- Getting Started
- Tutorials and Examples
- Configuring Tsdat
- API Reference
tsdat- Subpackages
tsdat.config- Submodules
tsdat.config.attributes- Classes
AttributeModelGlobalAttributesGlobalAttributes.code_urlGlobalAttributes.code_versionGlobalAttributes.conventionsGlobalAttributes.data_levelGlobalAttributes.dataset_nameGlobalAttributes.datastreamGlobalAttributes.descriptionGlobalAttributes.doiGlobalAttributes.historyGlobalAttributes.institutionGlobalAttributes.location_idGlobalAttributes.qualifierGlobalAttributes.referencesGlobalAttributes.temporalGlobalAttributes.titleGlobalAttributes.add_datastream_field()GlobalAttributes.warn_if_dynamic_properties_are_set()
- AttributeModel
- GlobalAttributes
- Classes
tsdat.config.datasettsdat.config.pipelinetsdat.config.qualitytsdat.config.retrievertsdat.config.storagetsdat.config.utilstsdat.config.variables- Classes
CoordinateVariableVariableAttributesVariableAttributes.commentVariableAttributes.fail_deltaVariableAttributes.fail_rangeVariableAttributes.fill_valueVariableAttributes.long_nameVariableAttributes.standard_nameVariableAttributes.unitsVariableAttributes.valid_deltaVariableAttributes.valid_rangeVariableAttributes.warn_deltaVariableAttributes.warn_rangeVariableAttributes.validate_unit()VariableAttributes.validate_units_are_commented()
- Coordinate
- Variable
- VariableAttributes
- Classes
- Submodules
tsdat.io- Submodules
tsdat.io.base- Classes
DataConverterDataHandlerDataReaderDataWriterFileHandlerFileWriterRetrievalRuleSelectionsRetrievedDatasetRetrieverStorage- DataConverter
- DataHandler
- DataReader
- DataWriter
- FileHandler
- FileWriter
- RetrievalRuleSelections
- RetrievedDataset
- Retriever
- Storage
- Classes
tsdat.io.converterstsdat.io.handlerstsdat.io.readerstsdat.io.retrieverstsdat.io.storagetsdat.io.writers
- Submodules
tsdat.misctsdat.pipelinetsdat.qc- Submodules
tsdat.qc.basetsdat.qc.checkers- Classes
CheckFailDeltaCheckFailMaxCheckFailMinCheckFailRangeMaxCheckFailRangeMinCheckMissingCheckMonotonicCheckValidDeltaCheckValidMaxCheckValidMinCheckValidRangeMaxCheckValidRangeMinCheckWarnDeltaCheckWarnMaxCheckWarnMinCheckWarnRangeMaxCheckWarnRangeMin- CheckFailDelta
- CheckFailMax
- CheckFailMin
- CheckFailRangeMax
- CheckFailRangeMin
- CheckMissing
- CheckMonotonic
- CheckValidDelta
- CheckValidMax
- CheckValidMin
- CheckValidRangeMax
- CheckValidRangeMin
- CheckWarnDelta
- CheckWarnMax
- CheckWarnMin
- CheckWarnRangeMax
- CheckWarnRangeMin
- Classes
tsdat.qc.handlers- Classes
DataQualityErrorFailPipelineRecordQualityResultsRemoveFailedValuesSortDatasetByCoordinate- DataQualityError
- FailPipeline
- RecordQualityResults
- RemoveFailedValues
- SortDatasetByCoordinate
- Classes
- Submodules
tsdat.transform- Submodules
tsdat.transform.adi- Classes
- Attributes
CDSObjectCOORDINATE_SYSTEMINPUT_DATASTREAMOUTPUT_DATASTREAMadi_qc_attsADIAlignmentsADITransformationTypesAdiTransformerTransformParameterConverter- CDSObject
- COORDINATE_SYSTEM
- INPUT_DATASTREAM
- OUTPUT_DATASTREAM
- adi_qc_atts
- ADIAlignments
- ADITransformationTypes
- AdiTransformer
- TransformParameterConverter
tsdat.transform.converters- Classes
- Submodules
- Submodules
tsdat.__main__tsdat.maintsdat.testingtsdat.tstringtsdat.utils- Classes
- Functions
- Attributes
DATASTREAM_TEMPLATEFILENAME_TEMPLATEParameterizedClassassign_data()decode_cf()generate_schema()get_datastream()get_fields_from_datastream()get_filename()get_start_date_and_time_str()get_start_time()record_corrections_applied()- DATASTREAM_TEMPLATE
- FILENAME_TEMPLATE
- ParameterizedClass
- assign_data
- decode_cf
- generate_schema
- get_datastream
- get_fields_from_datastream
- get_filename
- get_start_date_and_time_str
- get_start_time
- record_corrections_applied
- Classes
- Functions
- Attributes
DATASTREAM_TEMPLATEFILENAME_TEMPLATEConfigErrorDataQualityErrorCSVHandlerCSVReaderCSVWriterCheckFailDeltaCheckFailMaxCheckFailMinCheckFailRangeMaxCheckFailRangeMinCheckMissingCheckMonotonicCheckValidDeltaCheckValidMaxCheckValidMinCheckValidRangeMaxCheckValidRangeMinCheckWarnDeltaCheckWarnMaxCheckWarnMinCheckWarnRangeMaxCheckWarnRangeMinDataConverterDataHandlerDataReaderDataWriterDatasetConfigDefaultRetrieverFailPipelineFileHandlerFileSystemFileSystemS3FileWriterIngestPipelineNearestNeighborNetCDFHandlerNetCDFReaderNetCDFWriterOverrideableParameterizedClassParameterizedConfigClassParquetHandlerParquetReaderParquetWriterPipelinePipelineConfigQualityCheckerQualityConfigQualityHandlerQualityManagementQualityManagerRecordQualityResultsRemoveFailedValuesRetrievalRuleSelectionsRetrievedDatasetRetrieverRetrieverConfigSortDatasetByCoordinateSplitNetCDFHandlerSplitNetCDFWriterStorageStorageConfigStorageRetrieverStorageRetrieverInputStringToDatetimeTransformationPipelineUnitsConverterYamlModelZarrHandlerZarrLocalStorageZarrReaderZarrWriterZipReaderassert_close()assign_data()decode_cf()generate_schema()get_code_version()get_datastream()get_fields_from_datastream()get_filename()get_start_date_and_time_str()get_start_time()get_version()read_yaml()record_corrections_applied()recursive_instantiate()- DATASTREAM_TEMPLATE
- FILENAME_TEMPLATE
- ConfigError
- DataQualityError
- CSVHandler
- CSVReader
- CSVWriter
- CheckFailDelta
- CheckFailMax
- CheckFailMin
- CheckFailRangeMax
- CheckFailRangeMin
- CheckMissing
- CheckMonotonic
- CheckValidDelta
- CheckValidMax
- CheckValidMin
- CheckValidRangeMax
- CheckValidRangeMin
- CheckWarnDelta
- CheckWarnMax
- CheckWarnMin
- CheckWarnRangeMax
- CheckWarnRangeMin
- DataConverter
- DataHandler
- DataReader
- DataWriter
- DatasetConfig
- DefaultRetriever
- FailPipeline
- FileHandler
- FileSystem
- FileSystemS3
- FileWriter
- IngestPipeline
- NearestNeighbor
- NetCDFHandler
- NetCDFReader
- NetCDFWriter
- Overrideable
- ParameterizedClass
- ParameterizedConfigClass
- ParquetHandler
- ParquetReader
- ParquetWriter
- Pipeline
- PipelineConfig
- QualityChecker
- QualityConfig
- QualityHandler
- QualityManagement
- QualityManager
- RecordQualityResults
- RemoveFailedValues
- RetrievalRuleSelections
- RetrievedDataset
- Retriever
- RetrieverConfig
- SortDatasetByCoordinate
- SplitNetCDFHandler
- SplitNetCDFWriter
- Storage
- StorageConfig
- StorageRetriever
- StorageRetrieverInput
- StringToDatetime
- TransformationPipeline
- UnitsConverter
- YamlModel
- ZarrHandler
- ZarrLocalStorage
- ZarrReader
- ZarrWriter
- ZipReader
- assert_close
- assign_data
- decode_cf
- generate_schema
- get_code_version
- get_datastream
- get_fields_from_datastream
- get_filename
- get_start_date_and_time_str
- get_start_time
- get_version
- read_yaml
- record_corrections_applied
- recursive_instantiate
- Subpackages
- Collaboration
- Acknowledgements