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

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.4.tar.gz (97.9 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.4-py3-none-any.whl (133.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: openstef-3.0.4.tar.gz
  • Upload date:
  • Size: 97.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for openstef-3.0.4.tar.gz
Algorithm Hash digest
SHA256 038072000f68248069253ca3865aee587e720fd60e0e6a9adc3c8ef47ed0ae6e
MD5 a827adba9c707113ea820172a835ed64
BLAKE2b-256 d76ce75b30dc2f8fcd102da405907b6cb95222974c8018afc8beb70b246f6ece

See more details on using hashes here.

File details

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

File metadata

  • Download URL: openstef-3.0.4-py3-none-any.whl
  • Upload date:
  • Size: 133.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for openstef-3.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9bfd0e92e95691dbeea25605b9c0edfcd7b46ba123a54a6939bb12785fdb647f
MD5 49b042d26765e9ba7f4397062d375f74
BLAKE2b-256 3545c99dc3ba87d03a1788339805f28d59d325441ddc9ab113bf783708cd49d4

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