A package for exploration of regularly sampled time series.
Project description
Time Series Explorer (tseda)
An application for time series exploration.
Overview
tseda lets you explore regularly sampled time series with a sampling frequency of one hour or greater. It is currently limited to 2,000 samples (this is configurable).
Three-Step Exploration Workflow
(a) Initial Assessment
Explore the distribution and spread of values using a kernel density estimate and box plot. You get to see the raw distribution of the values. The PACF and ACF provide clues about seasonality and autoregressive components.
(b) Decomposition Using Singular Spectral Analysis
On the basis of the sampling frequency, a window for SSA is determined. This is a heuristic assignment. For example:
| Sampling Frequency | Window Size |
|---|---|
| Hourly | 24 |
| Monthly | 12 |
| Quarterly | 4 |
This can be changed in the UI. Based on the eigen value distribution, observations from the ACF plot and the eigen vector plot, the seasonal components can be determined if present. Based on these initial plots, the user needs to input a set of groupings and reconstruct the series with these groupings. The reconstruction plots are shown. If there is structure in the series, then change point analysis can be done using the fact that the components are smooth. A change point plot is shown. The explained variance from signal and noise components and the assessment of the noise structure (independent or correlated) is provided.
(c) Observation Logging
The SSA is based on the eigen decomposition of the trajectory matrix. Though the raw signal is correlated, the eigenvectors are uncorrelated. If we assume that the signal is Gaussian, this also implies independence. We can use the Akaike Information Criterion for model selection and determine the AIC as a function of the rank of the model. This is shown in the observation page. An automatic summary of all the observations is provided.
Notebook Interface
The package also provides a notebook interface to these features. If you have a new dataset that you want to analyze, look at the data loader directory for examples. Download your dataset, clean it, produce your time series, and analyze it with tseda.
Requirements
Python 3.13 or higher is required to run this package.
Before starting the installation, verify your Python version:
python --version
Ensure the output shows Python 3.13 or higher. If not, please upgrade Python before proceeding.
Install And Run From PyPI
Recommended: Using Conda
Conda is the recommended package manager for development and installation (development was done with conda):
conda create -n tseda python=3.13
conda activate tseda
pip install tseda
Then run the app:
tseda
Non-Developer Quick Start
If you just want to run the app with minimal setup:
- Install with
pipx:
pipx install tseda
- Launch the app:
tseda
- Open your browser at
http://127.0.0.1:8050.
If pipx is not available, use the standard Python install instructions below.
1. Install
Verify you have Python 3.13 or higher installed:
python --version
Create and activate a virtual environment, then install from PyPI:
python -m venv .venv
source .venv/bin/activate # Windows: .venv\Scripts\activate
pip install tseda
2. Run The Dash App
tseda
You can also launch with Python module execution:
python -m tseda
Note: python tseda is not a valid way to run an installed package because Python treats tseda as a local script path.
By default, the app starts at http://127.0.0.1:8050.
Optional runtime overrides:
TSEDA_HOST=0.0.0.0 TSEDA_PORT=8050 TSEDA_DEBUG=false tseda
3. Upload Your Data
- Click "Drag and Drop or Select Files" in the Initial Assessment panel.
- Your file must be a CSV or Excel file with at least two columns: a timestamp column (first) and a numeric value column (second).
- The data must be regularly sampled at hourly or lower frequency (e.g., hourly, daily, monthly).
- The dataset must contain no missing values (NA / NaN). Clean your data before uploading.
- Files are limited to 2,000 rows (configurable via
MAX_FILE_LINESints_analyze_ui.py).
4. Explore In Three Steps
| Step | Panel | What to do |
|---|---|---|
| 1 | Initial Assessment of Time Series | Review distribution plots (KDE, box plot) and the ACF / PACF for autocorrelation patterns. |
| 2 | Time Series Decomposition | Review the eigenvalue plot, then enter component groupings (e.g., Trend, Seasonal, Noise) and click Apply Grouping. |
| 3 | Observation Logging | Review the AIC rank diagnostics, read the auto-generated summary, and add your own observations before saving the report. |
Development Install (From Source)
If you are developing locally from source:
pip install -e .
tseda
Build With uv
- Build source and wheel distributions:
uv build
- Validate distributions before upload:
uvx twine check dist/*
Documentation (Sphinx)
Build locally
pip install -r docs/requirements.txt
sphinx-build -b html docs/source docs/_build/html
You can also use the Makefile:
make -C docs html
The generated site will be available in docs/_build/html.
Publish on Read the Docs
This repository includes .readthedocs.yaml configured to build docs from docs/source/conf.py.
- Push the repository to GitHub (or another supported provider).
- Sign in to Read the Docs and import the project.
- In Read the Docs project settings:
- Set the default branch.
- Confirm the config file path is
.readthedocs.yaml.
- Trigger a build from the Read the Docs dashboard.
- Optionally enable a custom domain and versioned docs.
If the build fails, inspect the Read the Docs build logs and replicate locally using:
make -C docs html
Contributing & Feature Requests
If you'd like to request a feature or report an issue, please open an issue on GitHub. You're also welcome to reach out to me directly.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file tseda-0.1.7.tar.gz.
File metadata
- Download URL: tseda-0.1.7.tar.gz
- Upload date:
- Size: 851.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b234bcf9b79d2c540fd76ba16fab0c8023cd56e6487252a0dea4a6a379550d49
|
|
| MD5 |
8bdae9431c673f6449c90379ca04f14f
|
|
| BLAKE2b-256 |
1ff2b8eaae303a49d97c2aa62227b7f69225ecb5e1c27725983a66fbc58f0929
|
File details
Details for the file tseda-0.1.7-py3-none-any.whl.
File metadata
- Download URL: tseda-0.1.7-py3-none-any.whl
- Upload date:
- Size: 853.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3ea94cc10b2c9802e131a8514ad9b1aada165c09d428a666d11d2fb3be8de238
|
|
| MD5 |
cc76ed27d1470b3a5bf2661d23b84a69
|
|
| BLAKE2b-256 |
c0fa0ee638f100a2c239f4fe80d3aafe67b773dddc300a484263b42f26ca89b1
|