/openstf

Open Short Term Forecasting package

Primary LanguageHTMLMozilla Public License 2.0MPL-2.0

Python Build REUSE Compliance Check

Quality Gate Status Bugs Code Smells Coverage Duplicated Lines (%) Maintainability Rating Reliability Rating Security Rating Technical Debt Vulnerabilities

Openstf

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

Installation

Install the openstf package

pip install openstf

Usage

To run a task use:

python -m openstf task <task_name>

Reference Implementation

A complete implementation including databases, user interface, example data, etc. is available at: https://github.com/alliander-opensource/openstf-reference image

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

N.V. Alliander - Team Korte Termijn Prognoses (Short Term Forecasting) korte.termijn.prognoses@alliander.com