Metadata-Version: 2.1
Name: openstf
Version: 1.5.1
Summary: Open short term forcasting
Home-page: https://github.com/alliander-opensource/short-term-forecasting
Author: Alliander N.V
Author-email: korte.termijn.prognoses@alliander.com
License: MPL-2.0
Keywords: energy,forecasting,machinelearning
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.7.0
Description-Content-Type: text/markdown
Requires-Dist: Cython (~=0.29.21)
Requires-Dist: cufflinks (~=0.17.3)
Requires-Dist: dill (~=0.3.3)
Requires-Dist: lightgbm (~=3.1.1)
Requires-Dist: numpy (~=1.20.0)
Requires-Dist: optuna (~=2.5.0)
Requires-Dist: pandas (~=1.2.1)
Requires-Dist: plotly (~=4.14.3)
Requires-Dist: pymsteams (~=0.1.14)
Requires-Dist: pytz (~=2021.1)
Requires-Dist: requests (~=2.25.1)
Requires-Dist: scikit-learn (~=0.24.1)
Requires-Dist: scipy (~=1.6.0)
Requires-Dist: setuptools (~=45.2.0)
Requires-Dist: sklearn (~=0.0)
Requires-Dist: wheel (~=0.36.2)
Requires-Dist: xgboost (~=1.3.3)

<!--
SPDX-FileCopyrightText: 2017-2021 Alliander N.V. <korte.termijn.prognoses@alliander.com>

SPDX-License-Identifier: MPL-2.0
-->

[![Main Build](https://github.com/alliander-opensource/short-term-forecasting/actions/workflows/python-build.yaml/badge.svg?branch=main)](https://github.com/alliander-opensource/short-term-forecasting/actions/workflows/python-build.yaml)
[![Develop Build](https://github.com/alliander-opensource/short-term-forecasting/actions/workflows/python-build.yaml/badge.svg?branch=develop)](https://github.com/alliander-opensource/short-term-forecasting/actions/workflows/python-build.yaml)
[![REUSE Compliance Check](https://github.com/alliander-opensource/short-term-forecasting/actions/workflows/reuse-compliance.yaml/badge.svg?branch=main)](https://github.com/alliander-opensource/short-term-forecasting/actions/workflows/reuse-compliance.yaml)

# Short Term Forcasting

Short term forcasting is a Python package which is used to make short term forecasts for the energy sector. This repository contains all components for the machine learning pipeline required to make a forecast. In order to use the package you need to provide your own data storage and retrieval interface.

# Installation

## Clone this repository:

```shell
git clone git@github.com:alliander-opensource/short-term-forecasting.git
```

## Install dependencies

```shell
pip install -r requirements.txt
```

## Install the openstf package

```shell
pip install -e openstf
```

## Install own implementation of ktpbase

The code in this repository expects a data storage and retrieval interface to be available through the `ktpbase` package. For more information about the implemented interface see TODO.

# Usage

To run a task use:

```shell
python -m openstf task <task_name>
```

## License
This project is licensed under the Mozilla Public License, version 2.0 - see LICENSE for details.

## Licenses third-party libraries
This project includes third-party libraries, which are licensed under their own respective Open-Source licenses. SPDX-License-Identifier headers are used to show which license is applicable. The concerning license files can be found in the LICENSES directory.

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## Contact

N.V. Alliander - Team Korte Termijn Prognoses <korte.termijn.prognoses@alliander.com>


