Metadata-Version: 2.5
Name: ontime
Version: 0.9
Summary: Your library to work with time series
Author-email: Fred Montet <fredmontet@gmail.com>
License-File: LICENSE
Requires-Python: <3.13,>=3.10
Requires-Dist: alive-progress<4,>=3.2.0
Requires-Dist: altair-viewer<0.5,>=0.4.0
Requires-Dist: altair<6,>=5.1.0
Requires-Dist: calmap<0.0.12,>=0.0.11
Requires-Dist: catboost~=1.2
Requires-Dist: darts>=0.37
Requires-Dist: ipywidgets<9,>=8.1.1
Requires-Dist: lightning<3,>=2.2.4
Requires-Dist: numpy<2,>=1.26.4
Requires-Dist: periodicity-detection<0.2,>=0.1.3
Requires-Dist: protobuf<5,>=4.24.4
Requires-Dist: skforecast>=0.19.1
Requires-Dist: tabulate<0.10,>=0.9.0
Requires-Dist: tensorflow<3,>=2.16.1
Requires-Dist: torch!=2.0.1,!=2.1.0,>=2.0.0
Requires-Dist: vega-datasets<0.10,>=0.9.0
Requires-Dist: vegafusion-python-embed<2,>=1.4.1
Requires-Dist: vegafusion[embed]<2,>=1.4.1
Description-Content-Type: text/markdown

[![Continuous Integration](https://github.com/ontime-re/ontime/actions/workflows/ci.yml/badge.svg)](https://github.com/ontime-re/ontime/actions/workflows/ci.yml)
[![PyPI version](https://badge.fury.io/py/ontime.svg)](https://badge.fury.io/py/ontime)

<div align="center">
    <img src="docs/_static/ontime-logo.png" width="180" title="hover text">
    <h1><i>your library to work with time series</i></h1>
</div>

## Getting Started

Install the library with:

    pip install ontime

Then, head over to the documentation on [ontime.re](https://ontime.re):

- the [Getting Started](https://ontime.re/getting_started) guide to install onTime and run your first example,
- the [User Guide](https://ontime.re/user_guide), a collection of notebooks that walk through the library's features in detail.

## Purpose of the library

onTime was created to support a technology transfer to the partners of the DiagnoBat
project, while respecting their intellectual property. Most of the library is built
around dynamically loaded classes, so anyone can extend it and keep company-specific
parts private.

The library's objectives are to:

  1. extend existing time series libraries (Darts, GluonTS, Kats, etc.),
  2. provide benchmarking tools for models and detectors,
  3. provide domain-specific tools (e.g. for energy consumption, district heating networks, etc.).

If you have any questions, feel free to open an issue or reach out by email.

## License

Apache License 2.0
