Welcome to Time Series Documentation

A comprehensive package for handling time series data with specialised focus on time intervals, aggregation, and data flagging.

Key Features

• Time series data structure: Robust time series data model built on Polars DataFrames

• Period-based time management: Flexible handling of time resolutions and periodicity (days, months, years, etc.)

• Aggregation framework: Easily aggregate time series data over various periods

• Flagging system: Built-in flagging system for data point management and provenance

• Column relationships: Define and manage relationships between data and metadata

Getting Started

Getting Started

• Quick Start
  • Creating a Time Series
  • Aggregating Data
  • Adding Flags for Quality Control
• Basic Concepts
  • TimeSeries Class
  • Time Management
  • Period Class
  • Column Types
  • Aggregation
  • Flagging System
  • Relationships
  • Metadata

User Guide

User Guide

• TimeSeries Basics
  • Creating a TimeSeries
  • Time Validation
  • Missing Rows
  • Accessing Data
  • Updating a TimeSeries
  • Working with Columns
  • Column Relationships
  • Aggregating Data
  • Best Practices
  • Next Steps
• Working with Periods
  • Understanding Periods
  • Creating Periods

Examples

API Reference

Developer Guide

Developer Guide

• Contributing
  • Writing documentation

Indices and tables

• Index

• Module Index

• Search Page

License

This project is licensed under the GNU General Public License v3.0 (GPLv3).

You may obtain a copy of the license at:

https://www.gnu.org/licenses/gpl-3.0.en.html

This software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.