openstef 3.4.62__tar.gz → 3.4.64__tar.gz

{openstef-3.4.62 → openstef-3.4.64}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: openstef
-Version: 3.4.62
+Version: 3.4.64
 Summary: Open short term energy forecaster
 Home-page: https://github.com/OpenSTEF/openstef
 Author: Alliander N.V
@@ -33,7 +33,11 @@ Requires-Dist: scikit-learn<1.6,>=1.3
 Requires-Dist: scipy~=1.10
 Requires-Dist: statsmodels<1.0.0,>=0.13.5
 Requires-Dist: structlog<25,>=23.1
-Requires-Dist: xgboost~=2.0
+Requires-Dist: xgboost~=2.0; extra == "gpu"
+Provides-Extra: cpu
+Requires-Dist: xgboost-cpu~=2.0; extra == "cpu"
+Provides-Extra: gpu
+Requires-Dist: xgboost; extra == "gpu"
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -42,6 +46,7 @@ Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: keywords
 Dynamic: license
+Dynamic: provides-extra
 Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
@@ -53,11 +58,15 @@ SPDX-License-Identifier: MPL-2.0
 -->
 
 # OpenSTEF
+
 <!-- Badges -->
+
 [![Downloads](https://static.pepy.tech/badge/openstef)](https://pepy.tech/project/openstef)
 [![Downloads](https://static.pepy.tech/badge/openstef/month)](https://pepy.tech/project/openstef)
 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5585/badge)](https://bestpractices.coreinfrastructure.org/projects/5585)
+
 <!-- SonarCloud badges -->
+
 [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=OpenSTEF_openstef&metric=bugs)](https://sonarcloud.io/dashboard?id=OpenSTEF_openstef)
 [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=OpenSTEF_openstef&metric=code_smells)](https://sonarcloud.io/dashboard?id=OpenSTEF_openstef)
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=OpenSTEF_openstef&metric=coverage)](https://sonarcloud.io/dashboard?id=OpenSTEF_openstef)
@@ -71,19 +80,21 @@ SPDX-License-Identifier: MPL-2.0
 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
+
 - [OpenSTEF](#openstef)
 - [Table of contents](#table-of-contents)
 - [External information sources](#external-information-sources)
 - [Installation](#installation)
 - [Usage](#usage)
-    - [Example notebooks](#example-notebooks)
-    - [Reference Implementation](#reference-implementation)
-    - [Database connector for OpenSTEF](#database-connector-for-openstef)
+  - [Example notebooks](#example-notebooks)
+  - [Reference Implementation](#reference-implementation)
+  - [Database connector for OpenSTEF](#database-connector-for-openstef)
 - [License](license)
 - [Contributing](#contributing)
 - [Contact](#contact)
 
 # External information sources
+
 - [Documentation website](https://openstef.github.io/openstef/index.html);
 - [Python package](https://pypi.org/project/openstef/);
 - [Linux Foundation project page](https://www.lfenergy.org/projects/openstef/);
@@ -101,9 +112,11 @@ 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:
+
 ```shell
 pip install pywin32==300
 ```
+
 For more information on this issue see the [readme of pywin32](https://github.com/mhammond/pywin32#installing-via-pip) or [this Github issue](https://github.com/mhammond/pywin32/issues/1865#issue-1212752696).
 
 ## Remark regarding installation on Apple Silicon
@@ -112,19 +125,31 @@ If you want to install the `openstef` package on Apple Silicon (Mac with M1-chip
 
 1. Run `brew install libomp` (if you haven’t installed Homebrew: [follow instructions here](https://brew.sh/))
 2. If your interpreter can not find the `libomp` installation in `/usr/local/bin`, it is probably in `/opt/brew/Cellar`. Run:
+
 ```sh
 mkdir -p /usr/local/opt/libomp/
 ln -s /opt/brew/Cellar/libomp/{your_version}/lib /usr/local/opt/libomp/lib
 ```
+
 3. Uninstall `xgboost` with `pip` (`pip uninstall xgboost`) and install with `conda-forge` (`conda install -c conda-forge xgboost`)
 4. 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:
+
+```shell
+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](https://github.com/OpenSTEF/openstef-offline-example).
 
 ## Reference Implementation
+
 A complete implementation including databases, user interface, example data, etc. is available at: https://github.com/OpenSTEF/openstef-reference
 
 ![screenshot](https://user-images.githubusercontent.com/60883372/146760483-29af3ac7-62af-4f13-98c7-982a79c517d1.jpg)
@@ -138,17 +163,21 @@ 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](https://github.com/OpenSTEF/openstef-dbc).
 
 # 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](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
- 

{openstef-3.4.62 → openstef-3.4.64}/README.md

@@ -5,11 +5,15 @@ SPDX-License-Identifier: MPL-2.0
 -->
 
 # OpenSTEF
+
 <!-- Badges -->
+
 [![Downloads](https://static.pepy.tech/badge/openstef)](https://pepy.tech/project/openstef)
 [![Downloads](https://static.pepy.tech/badge/openstef/month)](https://pepy.tech/project/openstef)
 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5585/badge)](https://bestpractices.coreinfrastructure.org/projects/5585)
+
 <!-- SonarCloud badges -->
+
 [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=OpenSTEF_openstef&metric=bugs)](https://sonarcloud.io/dashboard?id=OpenSTEF_openstef)
 [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=OpenSTEF_openstef&metric=code_smells)](https://sonarcloud.io/dashboard?id=OpenSTEF_openstef)
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=OpenSTEF_openstef&metric=coverage)](https://sonarcloud.io/dashboard?id=OpenSTEF_openstef)
@@ -23,19 +27,21 @@ SPDX-License-Identifier: MPL-2.0
 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
+
 - [OpenSTEF](#openstef)
 - [Table of contents](#table-of-contents)
 - [External information sources](#external-information-sources)
 - [Installation](#installation)
 - [Usage](#usage)
-    - [Example notebooks](#example-notebooks)
-    - [Reference Implementation](#reference-implementation)
-    - [Database connector for OpenSTEF](#database-connector-for-openstef)
+  - [Example notebooks](#example-notebooks)
+  - [Reference Implementation](#reference-implementation)
+  - [Database connector for OpenSTEF](#database-connector-for-openstef)
 - [License](license)
 - [Contributing](#contributing)
 - [Contact](#contact)
 
 # External information sources
+
 - [Documentation website](https://openstef.github.io/openstef/index.html);
 - [Python package](https://pypi.org/project/openstef/);
 - [Linux Foundation project page](https://www.lfenergy.org/projects/openstef/);
@@ -53,9 +59,11 @@ 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:
+
 ```shell
 pip install pywin32==300
 ```
+
 For more information on this issue see the [readme of pywin32](https://github.com/mhammond/pywin32#installing-via-pip) or [this Github issue](https://github.com/mhammond/pywin32/issues/1865#issue-1212752696).
 
 ## Remark regarding installation on Apple Silicon
@@ -64,19 +72,31 @@ If you want to install the `openstef` package on Apple Silicon (Mac with M1-chip
 
 1. Run `brew install libomp` (if you haven’t installed Homebrew: [follow instructions here](https://brew.sh/))
 2. If your interpreter can not find the `libomp` installation in `/usr/local/bin`, it is probably in `/opt/brew/Cellar`. Run:
+
 ```sh
 mkdir -p /usr/local/opt/libomp/
 ln -s /opt/brew/Cellar/libomp/{your_version}/lib /usr/local/opt/libomp/lib
 ```
+
 3. Uninstall `xgboost` with `pip` (`pip uninstall xgboost`) and install with `conda-forge` (`conda install -c conda-forge xgboost`)
 4. 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:
+
+```shell
+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](https://github.com/OpenSTEF/openstef-offline-example).
 
 ## Reference Implementation
+
 A complete implementation including databases, user interface, example data, etc. is available at: https://github.com/OpenSTEF/openstef-reference
 
 ![screenshot](https://user-images.githubusercontent.com/60883372/146760483-29af3ac7-62af-4f13-98c7-982a79c517d1.jpg)
@@ -90,17 +110,21 @@ 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](https://github.com/OpenSTEF/openstef-dbc).
 
 # 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](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
- 

{openstef-3.4.62 → openstef-3.4.64}/openstef/model/regressors/gblinear_quantile.py

@@ -306,7 +306,7 @@ class GBLinearQuantileOpenstfRegressor(OpenstfRegressor):
         feature_names = booster.feature_names
 
         # Get importance
-        feature_importance = [score.get(f, 0.0) for f in feature_names]
+        feature_importance = [np.abs(score.get(f, 0.0)) for f in feature_names]
         # Convert to array
         features_importance_array = np.array(feature_importance, dtype=np.float32)
 

openstef-3.4.64/openstef/plotting/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2017-2025 Contributors to the OpenSTEF project <korte.termijn.prognoses@alliander.com> # noqa E501>
+#
+# SPDX-License-Identifier: MPL-2.0

openstef-3.4.64/openstef/plotting/load_forecast_plotter.py

@@ -0,0 +1,216 @@
+# SPDX-FileCopyrightText: 2017-2025 Contributors to the OpenSTEF project <korte.termijn.prognoses@alliander.com> # noqa E501>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+from typing import Tuple, Optional
+
+import numpy as np
+from pydantic import BaseModel
+import pandas as pd
+import plotly.graph_objects as go
+import plotly.express as px
+
+
+class LoadForecastPlotter(BaseModel):
+    colormap: str = "Blues"
+    colormap_range: Tuple[float, float] = (0.2, 0.8)
+
+    fill_opacity: float = 0.5
+    stroke_opacity: float = 0.8
+    stroke_width: float = 1.5
+
+    def _get_color_by_value(self, value: float) -> str:
+        """Maps a normalized value to a color using the specified colormap.
+
+        Args:
+            value (float): A value between 0 and 1 to be mapped to a color.
+
+        Returns:
+            str: A color in the rgba format.
+        """
+        rescaled = self.colormap_range[0] + value * (
+            self.colormap_range[1] - self.colormap_range[0]
+        )
+        rescaled = min(1.0, max(0.0, rescaled))
+
+        return px.colors.sample_colorscale(
+            colorscale=self.colormap, samplepoints=[rescaled]
+        )[0]
+
+    def _get_quantile_colors(self, quantile: float) -> Tuple[str, str]:
+        """Generate fill and stroke colors for a given quantile using a colorscale.
+
+        Colors are determined based on the distance from the median (50th percentile).
+
+        Args:
+           quantile (float): The quantile value (0-100) to generate colors for.
+
+        Returns:
+           Tuple[str, str]: A tuple containing (fill_color, stroke_color).
+        """
+        fill_value = 1 - abs(quantile - 50.0) / 50.0
+        stroke_value = 1 - abs(quantile + 5.0 - 50.0) / 50.0
+        return (
+            self._get_color_by_value(fill_value),
+            self._get_color_by_value(stroke_value),
+        )
+
+    def _add_quantile_band(
+        self,
+        figure: go.Figure,
+        lower_quantile_data: pd.Series,
+        lower_quantile: float,
+        upper_quantile_data: pd.Series,
+        upper_quantile: float,
+    ):
+        """Add a quantile band to the plotly figure.
+
+        Creates a filled polygon representing the area between lower and upper quantiles,
+        and adds it to the provided figure along with hover information.
+
+        Args:
+            figure (go.Figure): The plotly figure to add the quantile band to.
+            lower_quantile_data (pd.Series): Series with data for the lower quantile.
+            lower_quantile (float): The percentile value of the lower quantile.
+            upper_quantile_data (pd.Series): Series with data for the upper quantile.
+            upper_quantile (float): The percentile value of the upper quantile.
+
+        Returns:
+            None: The figure is modified in place.
+        """
+        # Create polygon shape for the quantile band in counterclockwise order
+        x = list(lower_quantile_data.index) + list(upper_quantile_data.index[::-1])
+        y = list(lower_quantile_data) + list(upper_quantile_data[::-1])
+
+        # Get colors for the band
+        fill_color, stroke_color = self._get_quantile_colors(lower_quantile)
+
+        # Group traces by quantile range
+        legendgroup = f"quantile_{lower_quantile}_{upper_quantile}"
+
+        # Add a single trace that forms a filled polygon
+        figure.add_trace(
+            go.Scatter(
+                x=x,
+                y=y,
+                fill="toself",
+                fillcolor=f"rgba{fill_color[3:-1]}, {self.fill_opacity})",
+                line=dict(
+                    color=f"rgba{stroke_color[3:-1]}, {self.stroke_opacity})",
+                    width=self.stroke_width,
+                ),
+                name=f"{lower_quantile}%-{upper_quantile}%",
+                showlegend=True,
+                hoverinfo="skip",
+                legendgroup=legendgroup,
+            )
+        )
+
+        # Add an (invisible) line around the filled area to make quantile
+        # values selectable/hover-able.
+        # Hovering on filled area values is not supported by plotly.
+        figure.add_trace(
+            go.Scatter(
+                x=lower_quantile_data.index,
+                y=lower_quantile_data.values,
+                mode="lines",
+                line=dict(
+                    width=self.stroke_width,
+                    color=f"rgba{stroke_color[3:-1]}, {self.stroke_opacity})",
+                ),
+                customdata=np.column_stack(
+                    (lower_quantile_data.values, upper_quantile_data.values)
+                ),
+                hovertemplate=(
+                    f"{lower_quantile}%: %{{customdata[0]:,.4s}}<br>"
+                    f"{upper_quantile}%: %{{customdata[1]:,.4s}}"
+                    "<extra></extra>"
+                ),
+                name=f"{lower_quantile}%-{upper_quantile}% Hover Info",
+                showlegend=False,
+                legendgroup=legendgroup,
+            )
+        )
+
+    def plot(
+        self,
+        realized: Optional[pd.Series] = None,
+        forecast: Optional[pd.Series] = None,
+        quantiles: Optional[pd.DataFrame] = None,
+    ):
+        """Create a plot showing forecast quantiles and realized values.
+
+        Generates an interactive plotly figure displaying the forecast distribution
+        through quantile bands, the median forecast, and the actual realized values.
+
+        Args:
+            realized (pd.Series): Time series of realized (actual) values.
+            forecast (pd.Series): Time series of forecast values (typically the median).
+            quantiles (pd.DataFrame): DataFrame containing quantile predictions.
+                Column names should follow the format 'quantile_P{percentile:02d}',
+                e.g., 'quantile_P10', 'quantile_P90'.
+
+        Returns:
+            go.Figure: A plotly figure object with the configured visualization.
+        """
+        figure = go.Figure()
+
+        if quantiles is not None:
+            # Extract and sort quantile percentages
+            quantile_cols = [
+                col for col in quantiles.columns if col.startswith("quantile_P")
+            ]
+            percentiles = sorted([int(col.split("P")[1]) for col in quantile_cols])
+
+            # Add quantile bands from widest to narrowest
+            for i in range(len(percentiles) // 2):
+                lower_quantile, upper_quantile = percentiles[i], percentiles[-(i + 1)]
+                if float(lower_quantile) == 50.0:
+                    continue
+
+                self._add_quantile_band(
+                    figure=figure,
+                    lower_quantile_data=quantiles[f"quantile_P{lower_quantile:02d}"],
+                    lower_quantile=lower_quantile,
+                    upper_quantile_data=quantiles[f"quantile_P{upper_quantile:02d}"],
+                    upper_quantile=upper_quantile,
+                )
+
+        if forecast is not None:
+            # Add forecast line (50th percentile)
+            figure.add_trace(
+                go.Scatter(
+                    x=forecast.index,
+                    y=forecast,
+                    mode="lines",
+                    line=dict(color="blue", width=self.stroke_width),
+                    name="Forecast (50th)",
+                    customdata=forecast.values,
+                    hovertemplate="Forecast (50th): %{customdata:,.4s}<extra></extra>",
+                )
+            )
+
+        if realized is not None:
+            # Add realized values on top
+            figure.add_trace(
+                go.Scatter(
+                    x=realized.index,
+                    y=realized,
+                    mode="lines",
+                    line=dict(color="red", width=self.stroke_width),
+                    customdata=realized.values,
+                    hovertemplate="Realized: %{customdata:,.4s}<extra></extra>",
+                    name="Realized",
+                )
+            )
+
+        # Styling configuration
+        figure.update_layout(
+            title=f"Load Forecast vs Actual",
+            xaxis_title="Datetime [UTC]",
+            yaxis_title="Load [W]",
+            template="plotly_white",
+            hovermode="x unified",
+        )
+
+        return figure

{openstef-3.4.62 → openstef-3.4.64}/openstef.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: openstef
-Version: 3.4.62
+Version: 3.4.64
 Summary: Open short term energy forecaster
 Home-page: https://github.com/OpenSTEF/openstef
 Author: Alliander N.V
@@ -33,7 +33,11 @@ Requires-Dist: scikit-learn<1.6,>=1.3
 Requires-Dist: scipy~=1.10
 Requires-Dist: statsmodels<1.0.0,>=0.13.5
 Requires-Dist: structlog<25,>=23.1
-Requires-Dist: xgboost~=2.0
+Requires-Dist: xgboost~=2.0; extra == "gpu"
+Provides-Extra: cpu
+Requires-Dist: xgboost-cpu~=2.0; extra == "cpu"
+Provides-Extra: gpu
+Requires-Dist: xgboost; extra == "gpu"
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -42,6 +46,7 @@ Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: keywords
 Dynamic: license
+Dynamic: provides-extra
 Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
@@ -53,11 +58,15 @@ SPDX-License-Identifier: MPL-2.0
 -->
 
 # OpenSTEF
+
 <!-- Badges -->
+
 [![Downloads](https://static.pepy.tech/badge/openstef)](https://pepy.tech/project/openstef)
 [![Downloads](https://static.pepy.tech/badge/openstef/month)](https://pepy.tech/project/openstef)
 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5585/badge)](https://bestpractices.coreinfrastructure.org/projects/5585)
+
 <!-- SonarCloud badges -->
+
 [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=OpenSTEF_openstef&metric=bugs)](https://sonarcloud.io/dashboard?id=OpenSTEF_openstef)
 [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=OpenSTEF_openstef&metric=code_smells)](https://sonarcloud.io/dashboard?id=OpenSTEF_openstef)
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=OpenSTEF_openstef&metric=coverage)](https://sonarcloud.io/dashboard?id=OpenSTEF_openstef)
@@ -71,19 +80,21 @@ SPDX-License-Identifier: MPL-2.0
 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
+
 - [OpenSTEF](#openstef)
 - [Table of contents](#table-of-contents)
 - [External information sources](#external-information-sources)
 - [Installation](#installation)
 - [Usage](#usage)
-    - [Example notebooks](#example-notebooks)
-    - [Reference Implementation](#reference-implementation)
-    - [Database connector for OpenSTEF](#database-connector-for-openstef)
+  - [Example notebooks](#example-notebooks)
+  - [Reference Implementation](#reference-implementation)
+  - [Database connector for OpenSTEF](#database-connector-for-openstef)
 - [License](license)
 - [Contributing](#contributing)
 - [Contact](#contact)
 
 # External information sources
+
 - [Documentation website](https://openstef.github.io/openstef/index.html);
 - [Python package](https://pypi.org/project/openstef/);
 - [Linux Foundation project page](https://www.lfenergy.org/projects/openstef/);
@@ -101,9 +112,11 @@ 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:
+
 ```shell
 pip install pywin32==300
 ```
+
 For more information on this issue see the [readme of pywin32](https://github.com/mhammond/pywin32#installing-via-pip) or [this Github issue](https://github.com/mhammond/pywin32/issues/1865#issue-1212752696).
 
 ## Remark regarding installation on Apple Silicon
@@ -112,19 +125,31 @@ If you want to install the `openstef` package on Apple Silicon (Mac with M1-chip
 
 1. Run `brew install libomp` (if you haven’t installed Homebrew: [follow instructions here](https://brew.sh/))
 2. If your interpreter can not find the `libomp` installation in `/usr/local/bin`, it is probably in `/opt/brew/Cellar`. Run:
+
 ```sh
 mkdir -p /usr/local/opt/libomp/
 ln -s /opt/brew/Cellar/libomp/{your_version}/lib /usr/local/opt/libomp/lib
 ```
+
 3. Uninstall `xgboost` with `pip` (`pip uninstall xgboost`) and install with `conda-forge` (`conda install -c conda-forge xgboost`)
 4. 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:
+
+```shell
+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](https://github.com/OpenSTEF/openstef-offline-example).
 
 ## Reference Implementation
+
 A complete implementation including databases, user interface, example data, etc. is available at: https://github.com/OpenSTEF/openstef-reference
 
 ![screenshot](https://user-images.githubusercontent.com/60883372/146760483-29af3ac7-62af-4f13-98c7-982a79c517d1.jpg)
@@ -138,17 +163,21 @@ 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](https://github.com/OpenSTEF/openstef-dbc).
 
 # 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](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
- 

{openstef-3.4.62 → openstef-3.4.64}/openstef.egg-info/SOURCES.txt

@@ -85,6 +85,8 @@ openstef/pipeline/optimize_hyperparameters.py
 openstef/pipeline/train_create_forecast_backtest.py
 openstef/pipeline/train_model.py
 openstef/pipeline/utils.py
+openstef/plotting/__init__.py
+openstef/plotting/load_forecast_plotter.py
 openstef/postprocessing/__init__.py
 openstef/postprocessing/postprocessing.py
 openstef/preprocessing/__init__.py

{openstef-3.4.62 → openstef-3.4.64}/openstef.egg-info/requires.txt

@@ -17,4 +17,12 @@ scikit-learn<1.6,>=1.3
 scipy~=1.10
 statsmodels<1.0.0,>=0.13.5
 structlog<25,>=23.1
+
+[:extra == "gpu"]
 xgboost~=2.0
+
+[cpu]
+xgboost-cpu~=2.0
+
+[gpu]
+xgboost

{openstef-3.4.62 → openstef-3.4.64}/setup.py

@@ -18,6 +18,10 @@ def read_requirements_from_file():
                 line = line[: line.index("#")].strip()
             if len(line) == 0:
                 continue
+            if "xgboost" in line:
+                line = (
+                    line + '; extra == "gpu"'
+                )  # make sure xgboost is installed with GPU support when not specifying options
             requirements.append(line)
         return requirements
 
@@ -29,7 +33,7 @@ def read_long_description_from_readme():
 
 setup(
     name="openstef",
-    version="3.4.62",
+    version="3.4.64",
     packages=find_packages(include=["openstef", "openstef.*"]),
     description="Open short term energy forecaster",
     long_description=read_long_description_from_readme(),
@@ -55,4 +59,10 @@ setup(
         r"License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)",
         "Programming Language :: Python :: 3.11",
     ],
+    extras_require={
+        "cpu": [
+            "xgboost-cpu~=2.0"
+        ],  # Add xgboost-cpu to avoid install large xgboost package when not using GPU
+        "gpu": ["xgboost"],  # Needed to install xgboost with GPU support in normal case
+    },
 )