Metadata-Version: 2.1
Name: ontime
Version: 0.6.1
Summary: Your library to work with time series
Author: Fred Montet
Author-email: fredmontet@gmail.com
Requires-Python: >=3.10,<3.13
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: altair (>=5.1.0,<6.0.0)
Requires-Dist: altair-viewer (>=0.4.0,<0.5.0)
Requires-Dist: calmap (>=0.0.11,<0.0.12)
Requires-Dist: catboost (>=1.2,<2.0)
Requires-Dist: darts (>=0.25.0,<0.26.0)
Requires-Dist: ipywidgets (>=8.1.1,<9.0.0)
Requires-Dist: lightning (>=2.2.4,<3.0.0)
Requires-Dist: numpy (>=1.26.4,<2.0.0)
Requires-Dist: protobuf (>=4.24.4,<5.0.0)
Requires-Dist: skforecast (>=0.11.0,<0.12.0)
Requires-Dist: tensorflow (>=2.16.1,<3.0.0)
Requires-Dist: torch (>=2.0.0,!=2.0.1,!=2.1.0)
Requires-Dist: vega-datasets (>=0.9.0,<0.10.0)
Requires-Dist: vegafusion-python-embed (>=1.4.1,<2.0.0)
Requires-Dist: vegafusion[embed] (>=1.4.1,<2.0.0)
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, take a look at documentation on [ontime.re](https://ontime.re) with : 

- a [Getting Started](https://ontime.re/getting_started) as usual,
- a [User Guide](https://ontime.re/user_guide) with many notebooks as examples.

## Purpose of the library

The purpose of onTime is to make a technological transfer to the partners of the 
DiagnoBat project with respect to their intellectual property. Most parts of 
the library are extendable by using dynamically loaded classes. This
mecanism allows anyone to keep parts of the library private within their own company. 

The library objectives are :

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

In case you have any questions, don't hesitate to ask them by opening an issue or email.

## License

Apache License 2.0

