# The Timeseries Refinery

> The Timeseries Refinery is a platform to store, version, transform and monitor time series data. It centralizes data from internal silos and external APIs into a shared, curated catalog, queried on the fly or scraped on schedule.

Core objects: primary **series** (versioned, with full revision history), **formulas** (computed series written in a lisp-like language), **groups** (ensembles of series), **baskets** (saved search queries) and **folders** (a path tree over series). Data can be corrected through supervision, cached for performance, and used from Python, the browser, Excel or an MCP server.

The whole documentation is also available as a single plain-text file: https://refinery.docs.pythonian.fr/llms-full.txt

## Getting started

- [Installation](https://refinery.docs.pythonian.fr/getting_started/installation.html): install and configure a Refinery instance.
- [Package overview](https://refinery.docs.pythonian.fr/getting_started/package_overview.html): the components that make up the Refinery and how they fit together.
- [Basics](https://refinery.docs.pythonian.fr/getting_started/tutorials/beginner.html): first steps — create and read series from Python.
- [Create a time series information system](https://refinery.docs.pythonian.fr/getting_started/tutorials/medium.html): build a small end-to-end system (medium tutorial).
- [To the next level](https://refinery.docs.pythonian.fr/getting_started/tutorials/advanced.html): scrapers, scheduled tasks and advanced features (advanced tutorial).

## Core components

- [Working with series in Python](https://refinery.docs.pythonian.fr/core_components/usage.html): create, update, read, delete and inspect series with the Python API.
- [Working with series in the browser](https://refinery.docs.pythonian.fr/core_components/web_usage.html): the same operations from the web interface (Catalog, Quick View, Create, Delete, info page).
- [Supervision](https://refinery.docs.pythonian.fr/core_components/supervision.html): manual corrections over automated feeds, data provenance and the multi-series editor.
- [Formulas (computed series)](https://refinery.docs.pythonian.fr/core_components/formula.html): computed series, the formula editor, dependencies and caching.
- [Formula Language Reference](https://refinery.docs.pythonian.fr/core_components/formula_language.html): every formula operator, with examples.
- [Formula cache](https://refinery.docs.pythonian.fr/core_components/cache.html): materialize computed series for performance with cache policies.
- [Groups](https://refinery.docs.pythonian.fr/core_components/groups.html): work with ensembles of series (scenarios, members).
- [Folders](https://refinery.docs.pythonian.fr/core_components/folders.html): organise series in a path tree and find them by folder.
- [Search Query Language Reference](https://refinery.docs.pythonian.fr/core_components/search_language.html): the query language, baskets and the basket editor.
- [Task Manager Operations](https://refinery.docs.pythonian.fr/core_components/rework.html): schedule and monitor background tasks (rework).
- [Time Series Monitoring](https://refinery.docs.pythonian.fr/core_components/tswatch.html): watch update frequency and get alerts.
- [Excel addin](https://refinery.docs.pythonian.fr/core_components/exceladdin.html): read and edit series from Excel.
- [Dashboards](https://refinery.docs.pythonian.fr/core_components/dashboard.html): build plots, tables and balances from the dashboard admin page.
- [The MCP server](https://refinery.docs.pythonian.fr/core_components/mcp.html): expose the Refinery to LLM clients over MCP (pro feature).
- [Securing the Refinery](https://refinery.docs.pythonian.fr/core_components/security.html): authentication, roles and permissions.
- [Settings](https://refinery.docs.pythonian.fr/core_components/settings.html): instance-wide horizons, timezones and users.

## Operations

- [Configuration Reference](https://refinery.docs.pythonian.fr/configuration_reference.html): configuration files and options.
- [Best Practices](https://refinery.docs.pythonian.fr/best_practices.html): recommended patterns and conventions.
- [Formula Debugging Techniques](https://refinery.docs.pythonian.fr/operations/formula_debugging.html): diagnose and fix formulas.
- [Troubleshooting](https://refinery.docs.pythonian.fr/troubleshooting.html): common problems and fixes.

## Reference

- [API documentation](https://refinery.docs.pythonian.fr/api.html): the full Python and HTTP API surface.

## Optional

- [Full documentation (single file)](https://refinery.docs.pythonian.fr/llms-full.txt): every page concatenated as plain text.