Skip to main content

Open short term energy forecaster

Project description

Python Build REUSE Compliance Check

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

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.tw.martin98.com/project/openstef/

Installation

Install the openstef package

pip install openstef

Optional: if you would like to use the proloaf model with OpenSTEF 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 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, CONTRIBUTING.md and PROJECT_GOVERNANACE.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

This version

3.1.1

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.1.1.tar.gz (99.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openstef-3.1.1-py3-none-any.whl (136.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: openstef-3.1.1.tar.gz
  • Upload date:
  • Size: 99.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for openstef-3.1.1.tar.gz
Algorithm Hash digest
SHA256 9fa20c346adb6ccf3dbea8fa231bae098718e35b56a9d4bb3d34f2c67a4cd48e
MD5 ba1c03a62c03965bea4599e24cfde0fc
BLAKE2b-256 fcbd4b2fe7612bf479797ab5bca284ad076799d397915c8603cc6d44f2a50b4a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: openstef-3.1.1-py3-none-any.whl
  • Upload date:
  • Size: 136.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for openstef-3.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1ee49e1754f353444b9937a3c837eacbba5c873f2947668952ab7583760838a8
MD5 eb193fdd1c7aeab0ca96068aa5146261
BLAKE2b-256 5d9ad048c730967ab6645ca74c54d0e3d38af338c02036b8419af4d3c4951595

See more details on using hashes here.

Supported by

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