-
Notifications
You must be signed in to change notification settings - Fork 2
Update support md #27
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
JanMaartenvanDoorn
wants to merge
4
commits into
main
Choose a base branch
from
update-support-md
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,36 @@ | ||
| <!-- | ||
| SPDX-FileCopyrightText: 2017-2024 Alliander N.V. <openstef@lfenergy.org> | ||
| SPDX-FileCopyrightText: 2026 Contributors to the OpenSTEF project <openstef@lfenergy.org> | ||
|
|
||
| SPDX-License-Identifier: MPL-2.0 | ||
| --> | ||
| # Getting help | ||
|
|
||
| # Getting Help | ||
|
|
||
| There are a few ways to connect with the OpenSTEF project: | ||
|
|
||
| * Join the **#openstef Slack channel**, which is part of the [LF Energy Slack workspace](https://slack.lfenergy.org/). | ||
| * Depending on your work e-mail address, you may need to be invited in order to join the Slack workspace. If this is the case, please e-mail <openstef@lfenergy.org>. We are happy to invite you. | ||
| * Send a **direct message** to one of the most recent [contributors](https://github.com/OpenSTEF/openstef/graphs/contributors). | ||
| * Submit an [**issue**](https://github.com/OpenSTEF/openstef/issues). | ||
| * Submit an [**issue**](https://github.com/OpenSTEF/openstef/issues) in the individual repository. | ||
| * Join the four-weekly **community meeting**. You can find information, including meeting invite links, on [our wiki page](https://wiki.lfenergy.org/display/OS/Four-weekly+community+meeting). | ||
|
|
||
| ## How to ask for help | ||
| ## How to ask for help, suggest a feature, or give recommendations | ||
|
|
||
| If you have trouble installing, building, or using OpenSTEF, | ||
| but there's not yet reason to suspect you've encountered a genuine bug, | ||
| start by posting a question to the **#openstef Slack channel**. | ||
|
|
||
| If you have trouble installing, building, or using OpenSTEF, but there's no reason yet to suspect you have encountered a genuine bug, | ||
| start by posting a question to the **Slack channel**. | ||
| This is the place for question such has "How do I...". | ||
| If you have an idea for a new feature or some recommendations for existing features or documentation, | ||
| you can also propose it in the **Slack channel** or submit an [issue](https://github.com/OpenSTEF/openstef/issues). | ||
|
|
||
| ## How to report a bug or request an enhancement | ||
| ## How to report a bug | ||
|
|
||
| This project manages bug and enhancement using the [GitHub issue tracker](https://github.com/OpenSTEF/openstef/issues). | ||
| The issue template will guide you on making an effective report. | ||
| This project manages bug and enhancement using the GitHub issue tracker. | ||
| The various issue templates will guide you on making an effective report. | ||
|
|
||
| ## How to report a security vulnerability | ||
|
|
||
| If you think you have found a potential vulnerability in this project, | ||
| please e-mail <openstef@lfenergy.org> to responsibly disclose it. | ||
| Please refer to [SECURITY.md](./SECURITY.md) for details on reporting a security vulnerability. | ||
|
|
||
| ## Contributing a fix | ||
|
|
||
| Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) to make a project contribution. | ||
| Please refer to [CONTRIBUTING.md](./CONTRIBUTING.md) to make a project contribution. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,9 @@ | ||
| <!-- | ||
| SPDX-FileCopyrightText: 2026 Contributors to the OpenSTEF project <openstef@lfenergy.org> | ||
|
|
||
| SPDX-License-Identifier: MPL-2.0 | ||
| --> | ||
|
|
||
| # OpenSTEF - Open Short Term Energy Forecasting | ||
| [](https://github.com/openstef/openstef/blob/main/LICENSE) | ||
| [](https://bestpractices.coreinfrastructure.org/projects/5585) | ||
|
|
@@ -19,15 +25,15 @@ OpenSTEF provides automated machine learning pipelines to deliver accurate and e | |
| - [Python package](https://pypi.org/project/openstef/); | ||
| - [Project website](https://www.lfenergy.org/projects/openstef/); | ||
| - [Dashboard documentation](https://raw.githack.com/OpenSTEF/.github/main/profile/html/openstef_dashboard_doc.html); | ||
| - [Linux Foundation project page](https://openstef.github.io/openstef/index.html); | ||
| - [Linux Foundation project page](https://www.lfenergy.org/projects/openstef/); | ||
| - [Video about OpenSTEF](https://www.lfenergy.org/forecasting-to-create-a-more-resilient-optimized-grid/); | ||
| - [OpenSTEF Slack channel](https://app.slack.com/huddle/TLU68MTML/C04P56MSM40). | ||
| - [OpenSTEF Slack channel](https://slack.lfenergy.org/). | ||
|
|
||
|
|
||
| ## Description | ||
| The energy transition poses new challenges to all parties within the energy sector. Grid operators, grappling with the upsurge in renewable energy and heightened electrification, find their grid capacities nearing physical limitations. Therefore, it is imperative to forecast grid load in the upcoming hours to days, enabling the anticipation of local congestion and thereby optimal utilization of existing assets. | ||
|
|
||
| OpenSTEF provides a complete software stack specifically engineered to forecast the load on the electricity grid for the next hours to days. Given a timeseries of measured (net) load or generation, a fully automated machine learning pipeline is executed which delivers a probabilistic forecast of future load. This is applicable to energy consumption, renewable generation, or a combination of the two. OpenSTEF does not stop at forecating: it validates input data, combines measurements with external predictors such as weather data and market prices, trains any scikit-learn compatible machine learning model, and delivers the forecast via both an API and an (expert) graphical user interface. The entire stack, crafted on open-source technology and adhering to standards, is organized in a microservice architecture optimized for cloud-deployment. | ||
| OpenSTEF provides a complete software stack specifically engineered to forecast the load on the electricity grid for the next hours to days. Given a timeseries of measured (net) load or generation, a fully automated machine learning pipeline is executed which delivers a probabilistic forecast of future load. This is applicable to energy consumption, renewable generation, or a combination of the two. OpenSTEF does not stop at forecasting: it validates input data, combines measurements with external predictors such as weather data and market prices, trains any scikit-learn compatible machine learning model, and delivers the forecast via both an API and an (expert) graphical user interface. The entire stack, crafted on open-source technology and adhering to standards, is organized in a microservice architecture optimized for cloud-deployment. | ||
|
|
||
| The Dutch DSO Alliander started the Short-Term-Forecasting project to anticipate congestion in the distribution grid, to allow for grid safety analysis in the transmission grid and to enable smart grid innovations to locally balance supply and demand within the constraints of the grid. The objective of opensourcing the stack is two-fold: provide an industry standard for generating and evaluating forecasts in the operational time-domain, as well as allow for structured collaboration. | ||
|  | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We do not provide this dashboard anymore. Maybe just remove it for now? We could later add some plots from BEAM. |
||
|
|
@@ -40,7 +46,7 @@ OpenSTEF has different repositories. | |
|
|
||
| [OpenSTEF-reference](https://github.com/OpenSTEF/openstef-reference): Deploy the entire OpenSTEF stack on your machine. Provides a reference implementation of the OpenSTEF stack including datamodels, databases and UI. | ||
|
|
||
| [OpenSTEF-offline-example](https://github.com/OpenSTEF/openstef-offline-example): Provides Jupyter Notebooks showing how to use OpenSTEF and apply it's functionality to your usecase. | ||
| [OpenSTEF-offline-example](https://github.com/OpenSTEF/openstef-offline-example): Provides Jupyter Notebooks showing how to use OpenSTEF and apply its functionality to your usecase. | ||
|
|
||
| ## Framework features | ||
| - Prediction job: input configuration for a task or pipeline. It contains for example the location and forecasting horizon. | ||
|
|
@@ -55,7 +61,7 @@ OpenSTEF has different repositories. | |
| This project is licensed under the Mozilla Public License, version 2.0. | ||
|
|
||
| ## Contributing | ||
| Please read [CODE_OF_CONDUCT.md](https://github.com/OpenSTEF/.github/blob/main/CODE_OF_CONDUCT.md), [CONTRIBUTING.md](https://github.com/OpenSTEF/.github/blob/main/CONTRIBUTING.md) and [PROJECT_GOVERNANACE.md](https://github.com/OpenSTEF/.github/blob/main/PROJECT_GOVERNANCE.md) for details on the process for submitting pull requests to us. | ||
| Please read [CODE_OF_CONDUCT.md](https://github.com/OpenSTEF/.github/blob/main/CODE_OF_CONDUCT.md), [CONTRIBUTING.md](https://github.com/OpenSTEF/.github/blob/main/CONTRIBUTING.md) and [PROJECT_GOVERNANCE.md](https://github.com/OpenSTEF/.github/blob/main/PROJECT_GOVERNANCE.md) for details on the process for submitting pull requests to us. | ||
|
|
||
| ## Contact | ||
| Please read [SUPPORT.md](https://github.com/OpenSTEF/.github/blob/main/SUPPORT.md) for how to connect and get into contact with the OpenSTEF project | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This part is outdated, especially the last part is more about OpenSTEF v3. We do not provide a GUI anymore.