Skip to main content

Open short term energy forecaster

Project description

OpenSTEF

Downloads Downloads CII Best Practices

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

OpenSTEF is a Python package designed for generating short-term forecasts in the energy sector. The repository includes all the essential components required for machine learning pipelines that facilitate the forecasting process. To utilize the package, users are required to furnish their own data storage and retrieval interface.

Table of contents

External information sources

Installation

Install the openstef package

pip install openstef

Remark regarding installation within a conda environment on Windows

A version of the pywin32 package will be installed as a secondary dependency along with the installation of the openstef package. Since conda relies on an old version of pywin32, the new installation can break conda's functionality. The following command can solve this issue:

pip install pywin32==300

For more information on this issue see the readme of pywin32 or this Github issue.

Remark regarding installation on Apple Silicon

If you want to install the openstef package on Apple Silicon (Mac with M1-chip or newer), you can encounter issues with the dependencies, such as xgboost. Solution:

  1. Run brew install libomp (if you haven’t installed Homebrew: follow instructions here)
  2. If your interpreter can not find the libomp installation in /usr/local/bin, it is probably in /opt/brew/Cellar. Run:
mkdir -p /usr/local/opt/libomp/
ln -s /opt/brew/Cellar/libomp/{your_version}/lib /usr/local/opt/libomp/lib
  1. Uninstall xgboost with pip (pip uninstall xgboost) and install with conda-forge (conda install -c conda-forge xgboost)
  2. If you encounter similar issues with lightgbm: uninstall lightgbm with pip (pip uninstall lightgbm) and install later version with conda-forge (conda install -c conda-forge 'lightgbm>=4.2.0')

Remark regarding installation with minimal XGBoost dependency

It is possible to install openSTEF with a minimal XGBoost (CPU-only) package. This only works on x86_64 (amd64) Linux and Windows platforms. Advantage is that significantly smaller dependencies are installed. In that case run:

pip install openstef[cpu]

Usage

Example notebooks

To help you get started, a set of fundamental example notebooks has been created. You can access these offline examples here.

Reference Implementation

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

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

To run a task use:

python -m openstef task <task_name>

Database connector for openstef

This repository provides an interface to OpenSTEF (reference) databases. The repository 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, CONTRIBUTING.md and PROJECT_GOVERNANCE.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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openstef-3.4.79.tar.gz (248.5 kB view details)

Uploaded Source

Built Distribution

openstef-3.4.79-py3-none-any.whl (304.6 kB view details)

Uploaded Python 3

File details

Details for the file openstef-3.4.79.tar.gz.

File metadata

  • Download URL: openstef-3.4.79.tar.gz
  • Upload date:
  • Size: 248.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for openstef-3.4.79.tar.gz
Algorithm Hash digest
SHA256 75d66aca2d98296b5c2b83b4ee067ad61abe90afbe6ef0ba884aef85036800c5
MD5 58951253426aadd48231dd3848013f1e
BLAKE2b-256 34c078ac257ae118c9f913676f482d4b4b6cf81d44de257aa54b045ecf433ef8

See more details on using hashes here.

Provenance

The following attestation bundles were made for openstef-3.4.79.tar.gz:

Publisher: python-upload-package.yaml on OpenSTEF/openstef

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openstef-3.4.79-py3-none-any.whl.

File metadata

  • Download URL: openstef-3.4.79-py3-none-any.whl
  • Upload date:
  • Size: 304.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for openstef-3.4.79-py3-none-any.whl
Algorithm Hash digest
SHA256 c21e816f8a014163d30a0f7fa2764f5a6437e80500c60915bc3544e256125e2c
MD5 3ddfcc22ccfcb31c2ed59896dd4ac9d9
BLAKE2b-256 13701bf5d665c7f59b65c45546fcee715bfbe23415c25722de865eb5a18e7952

See more details on using hashes here.

Provenance

The following attestation bundles were made for openstef-3.4.79-py3-none-any.whl:

Publisher: python-upload-package.yaml on OpenSTEF/openstef

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page