openstf 1.5.2

Open short term forcasting

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:

git clone [e-mail]:alliander-opensource/short-term-forecasting.git

Install dependencies

pip install -r requirements.txt

Install the openstf package

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:

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 for details on our code of conduct, and the process for submitting pull requests to us.

Contact

N.V. Alliander - Team Korte Termijn Prognoses [e-mail]