Skip to main content

Open short term energy forecaster

Project description

Python Build REUSE Compliance Check

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

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 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 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

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.0.5a5.tar.gz (98.1 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.0.5a5-py3-none-any.whl (133.1 kB view details)

Uploaded Python 3

File details

Details for the file openstef-3.0.5a5.tar.gz.

File metadata

  • Download URL: openstef-3.0.5a5.tar.gz
  • Upload date:
  • Size: 98.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1

File hashes

Hashes for openstef-3.0.5a5.tar.gz
Algorithm Hash digest
SHA256 4f8b74c2532c1650d0dc3a1c8f7691852c39dd0d29c6dbfcd6cc4234afd74ece
MD5 f33914a95f57722e7522b0005e713183
BLAKE2b-256 fe7857cb58509538600b478816d59f9641f2f86f009d5fd27ae567cd428da763

See more details on using hashes here.

File details

Details for the file openstef-3.0.5a5-py3-none-any.whl.

File metadata

  • Download URL: openstef-3.0.5a5-py3-none-any.whl
  • Upload date:
  • Size: 133.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1

File hashes

Hashes for openstef-3.0.5a5-py3-none-any.whl
Algorithm Hash digest
SHA256 93f47d3e6ce915a48b83ab4bb4edaf88605206a16604f39eb3fd460e4ea90b93
MD5 d99bf390f20be552e147afedcd332213
BLAKE2b-256 ac2f0a6af0aa363fb66c8ff97c28b257c4f5da446bf0aff87fb4aa82a6caa01a

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