openstef 3.0.5a5

Open short term energy forecaster

Openstef

OpenSTEF 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. openstef is available at: https://pypi.org/project/openstef/

Installation

Install the openstef package

pip install openstef

Optional: if you would like to use the proloaf model with openSTF install the proloaf dependencies by running:

pip install openstef[proloaf]

Usage

To run a task use:

python -m openstef task <task_name>

Reference Implementation

A complete implementation including databases, user interface, example data, etc. is available at: https://github.com/OpenSTEF/openstef-reference

Screenshot of the operational dashboard showing the key functionality of OpenSTEF. Dashboard documentation can be found here.

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 CODE_OF_CONDUCT.md and CONTRIBUTING.md for details on the process for submitting pull requests to us.

Contact

Please read SUPPORT.md for how to connect and get into contact with the OpenSTEF project