openenergyid 0.1.21__tar.gz → 0.1.29__tar.gz

openenergyid-0.1.29/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.4
+Name: openenergyid
+Version: 0.1.29
+Summary: Open Source Python library for energy analytics and simulations
+Author-email: Jan Pecinovsky <jan@energieid.be>, Max Helskens <max@energieid.be>, Oscar Swyns <oscar@energieid.be>
+License-Expression: MIT
+Keywords: energy,analytics,simulation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandera[polars]>=0.22.1
+Requires-Dist: pydantic>=2.8.2
+Requires-Dist: statsmodels>=0.14.2
+Dynamic: license-file
+
+# OpenEnergyID
+
+Open Source Python library for energy data analytics and simulations
+
+[*more info for developers*](DEVELOPERS.md)

{openenergyid-0.1.21 → openenergyid-0.1.29}/openenergyid/__init__.py

@@ -1,6 +1,6 @@
 """Open Energy ID Python SDK."""
 
-__version__ = "0.1.21"
+__version__ = "0.1.28"
 
 from .enums import Granularity
 from .models import TimeDataFrame, TimeSeries

{openenergyid-0.1.21 → openenergyid-0.1.29}/openenergyid/baseload/analysis.py

@@ -163,11 +163,13 @@ class BaseloadAnalyzer:
                         pl.col("total_consumption_in_kilowatthour")
                         - pl.col("consumption_due_to_baseload_in_kilowatthour")
                     ).alias("consumption_not_due_to_baseload_in_kilowatthour"),
-                    # What fraction of total energy was from baseload
-                    (
+                    pl.when(pl.col("total_consumption_in_kilowatthour") != 0)
+                    .then(
                         pl.col("consumption_due_to_baseload_in_kilowatthour")
                         / pl.col("total_consumption_in_kilowatthour")
-                    ).alias("baseload_ratio"),
+                    )
+                    .otherwise(None)
+                    .alias("baseload_ratio"),
                 ]
             )
         )

{openenergyid-0.1.21 → openenergyid-0.1.29}/openenergyid/dyntar/models.py

@@ -95,16 +95,6 @@ class DynamicTariffAnalysisOutputSummary(BaseModel):
 class DynamicTariffAnalysisOutput(TimeDataFrame):
     """Output frame for dynamic tariff analysis."""
 
-    columns: list[OutputColumns] = Field(
-        min_length=1,
-        max_length=len(OutputColumns.__args__),
-        examples=[OutputColumns.__args__],
-    )
-    data: list[
-        conlist(
-            item_type=confloat(allow_inf_nan=True),
-            min_length=1,
-            max_length=len(OutputColumns.__args__),
-        )  # type: ignore
-    ] = Field(examples=[[0.0] * len(OutputColumns.__args__)])
+    columns: list[str]
+    data: list[list[float | None]]
     summary: DynamicTariffAnalysisOutputSummary | None = None

{openenergyid-0.1.21 → openenergyid-0.1.29}/openenergyid/models.py

@@ -88,7 +88,11 @@ class TimeSeries(TimeSeriesBase):
     @classmethod
     def from_pandas(cls, data: pd.Series) -> Self:
         """Create from a Pandas Series."""
-        return cls(name=str(data.name), data=data.tolist(), index=data.index.tolist())
+        if not hasattr(data, "name") or data.name is None:
+            name = None
+        else:
+            name = str(data.name)
+        return cls(name=name, data=data.tolist(), index=data.index.tolist())
 
     def to_pandas(self, timezone: str = "UTC") -> pd.Series:
         """Convert to a Pandas Series."""

{openenergyid-0.1.21 → openenergyid-0.1.29}/openenergyid/mvlr/mvlr.py

@@ -206,9 +206,9 @@ class MultiVariableLinearRegression:
 
     def _do_analysis_cross_validation(self):
         """Find the best model (fit) based on cross-valiation (leave one out)"""
-        assert (
-            len(self.data) < 15
-        ), "Cross-validation is not implemented if your sample contains more than 15 datapoints"
+        assert len(self.data) < 15, (
+            "Cross-validation is not implemented if your sample contains more than 15 datapoints"
+        )
 
         # initialization: first model is the mean, but compute cv correctly.
         errors = []

openenergyid-0.1.29/openenergyid.egg-info/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.4
+Name: openenergyid
+Version: 0.1.29
+Summary: Open Source Python library for energy analytics and simulations
+Author-email: Jan Pecinovsky <jan@energieid.be>, Max Helskens <max@energieid.be>, Oscar Swyns <oscar@energieid.be>
+License-Expression: MIT
+Keywords: energy,analytics,simulation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandera[polars]>=0.22.1
+Requires-Dist: pydantic>=2.8.2
+Requires-Dist: statsmodels>=0.14.2
+Dynamic: license-file
+
+# OpenEnergyID
+
+Open Source Python library for energy data analytics and simulations
+
+[*more info for developers*](DEVELOPERS.md)

openenergyid-0.1.29/openenergyid.egg-info/SOURCES.txt

@@ -0,0 +1,33 @@
+LICENSE
+README.md
+pyproject.toml
+openenergyid/__init__.py
+openenergyid/const.py
+openenergyid/enums.py
+openenergyid/models.py
+openenergyid.egg-info/PKG-INFO
+openenergyid.egg-info/SOURCES.txt
+openenergyid.egg-info/dependency_links.txt
+openenergyid.egg-info/requires.txt
+openenergyid.egg-info/top_level.txt
+openenergyid/baseload/__init__.py
+openenergyid/baseload/analysis.py
+openenergyid/baseload/exceptions.py
+openenergyid/baseload/models.py
+openenergyid/capacity/__init__.py
+openenergyid/capacity/main.py
+openenergyid/capacity/models.py
+openenergyid/dyntar/__init__.py
+openenergyid/dyntar/const.py
+openenergyid/dyntar/main.py
+openenergyid/dyntar/models.py
+openenergyid/energysharing/__init__.py
+openenergyid/energysharing/const.py
+openenergyid/energysharing/data_formatting.py
+openenergyid/energysharing/main.py
+openenergyid/energysharing/models.py
+openenergyid/mvlr/__init__.py
+openenergyid/mvlr/helpers.py
+openenergyid/mvlr/main.py
+openenergyid/mvlr/models.py
+openenergyid/mvlr/mvlr.py

openenergyid-0.1.29/openenergyid.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

openenergyid-0.1.29/openenergyid.egg-info/requires.txt

@@ -0,0 +1,3 @@
+pandera[polars]>=0.22.1
+pydantic>=2.8.2
+statsmodels>=0.14.2

openenergyid-0.1.29/openenergyid.egg-info/top_level.txt

@@ -0,0 +1 @@
+openenergyid

openenergyid-0.1.29/pyproject.toml

@@ -0,0 +1,58 @@
+[project]
+name = "openenergyid"
+version = "0.1.29"
+description = "Open Source Python library for energy analytics and simulations"
+authors = [
+    { name = "Jan Pecinovsky", email = "jan@energieid.be" },
+    { name = "Max Helskens", email = "max@energieid.be" },
+    { name = "Oscar Swyns", email = "oscar@energieid.be" }
+]
+readme = "README.md"
+license = "MIT"
+keywords = ["energy", "analytics", "simulation"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Scientific/Engineering :: Mathematics",
+    "Topic :: Scientific/Engineering :: Physics",
+    "Topic :: Software Development :: Libraries :: Python Modules"
+]
+requires-python = ">=3.11"
+dependencies = [
+    "pandera[polars]>=0.22.1",
+    "pydantic>=2.8.2",
+    "statsmodels>=0.14.2",
+]
+
+[tool.ruff]
+line-length = 100
+
+[dependency-groups]
+dev = [
+    "altair>=5.5.0",
+    "deptry>=0.23.0",
+    "energyid>=0.0.17",
+    "entsoe-py>=0.6.19",
+    "ipykernel>=6.29.5",
+    "jupyter>=1.1.1",
+    "matplotlib>=3.10.3",
+    "notebook>=7.4.3",
+    "pandoc>=2.4",
+    "pip>=25.1.1",
+    "plotly>=6.1.2",
+    "pyarrow>=20.0.0",
+    "pyinstrument>=5.0.2",
+    "pytest>=8.4.0",
+    "seaborn>=0.13.2",
+    "snakeviz>=2.2.2",
+    "vegafusion>=2.0.2",
+    "vl-convert-python>=1.8.0",
+]
+
+[tool.setuptools.packages.find]
+include = ["openenergyid*"]

openenergyid-0.1.29/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

openenergyid-0.1.21/.devcontainer/devcontainer.json

@@ -1,42 +0,0 @@
-{
-  "name": "Python 3",
-  "image": "mcr.microsoft.com/devcontainers/python:1.1.9-3.11-bookworm",
-  "features": {},
-  "postCreateCommand": "zsh -l .devcontainer/post-install.sh",
-  // "postStartCommand": "",
-  "workspaceMount": "source=${localWorkspaceFolder},target=/workspaces/${localWorkspaceFolderBasename},type=bind,consistency=cached",
-  "workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
-  "remoteUser": "root",
-  "customizations": {
-    "vscode": {
-      "extensions": [
-        "ms-toolsai.jupyter",
-        "charliermarsh.ruff",
-        "ms-python.pylint",
-        "ms-python.vscode-pylance",
-        "visualstudioexptteam.vscodeintellicode",
-        "esbenp.prettier-vscode",
-        "GitHub.vscode-pull-request-github",
-        "mhutchie.git-graph",
-        "ms-toolsai.jupyter"
-      ],
-      "settings": {
-        "python.pythonPath": "/usr/local/bin/python",
-        "python.testing.pytestArgs": ["--no-cov"],
-        "editor.formatOnPaste": false,
-        "editor.formatOnSave": true,
-        "editor.formatOnType": true,
-        "files.trimTrailingWhitespace": true,
-        "terminal.integrated.profiles.linux": {
-          "zsh": {
-            "path": "/usr/bin/zsh"
-          }
-        },
-        "terminal.integrated.defaultProfile.linux": "zsh",
-        "[python]": {
-          "editor.defaultFormatter": "charliermarsh.ruff"
-        }
-      }
-    }
-  }
-}

openenergyid-0.1.21/.devcontainer/post-install.sh

@@ -1,22 +0,0 @@
-#!/bin/zsh -l
-# Add the current directory to Git's safe directory list
-git config --global --add safe.directory /workspaces/OpenEnergyID
-
-# Install Python tools
-pipx install ruff poetry pre-commit
-
-# Install project dependencies using Poetry
-poetry install
-
-# Install pre-commit hooks
-pre-commit install
-
-# Install ZSH plugins
-git clone https://github.com/zsh-users/zsh-autosuggestions ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-autosuggestions
-git clone https://github.com/zsh-users/zsh-syntax-highlighting.git ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-syntax-highlighting
-
-# Update .zshrc to enable plugins
-sed -i 's/plugins=(git)/plugins=(git zsh-autosuggestions zsh-syntax-highlighting)/' ~/.zshrc
-
-# Source the updated configuration
-source ~/.zshrc

openenergyid-0.1.21/.gitattributes

@@ -1,21 +0,0 @@
-# Set default behavior to LF
-* text=auto eol=lf
-
-# Explicitly declare files that should always use LF
-*.py text eol=lf
-*.json text eol=lf
-*.md text eol=lf
-*.yaml text eol=lf
-*.yml text eol=lf
-*.sh text eol=lf
-*.ndjson text eol=lf
-*.html text eol=lf
-*.toml text eol=lf
-*.txt text eol=lf
-*.dat text eol=lf
-*.lock text eol=lf
-
-# Denote all files that are truly binary and should not be modified
-*.png binary
-*.jpg binary
-*.gif binary

openenergyid-0.1.21/.github/workflows/python-publish.yml

@@ -1,38 +0,0 @@
-# This workflow will upload a Python Package using Twine when a release is created
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
-
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-
-name: Upload Python Package
-
-on:
-  release:
-    types: [published]
-
-permissions:
-  contents: read
-
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    permissions:
-        id-token: write
-    environment: release
-
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python
-      uses: actions/setup-python@v3
-      with:
-        python-version: '3.x'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install build
-    - name: Build package
-      run: python -m build
-    - name: Publish package
-      uses: pypa/gh-action-pypi-publish@release/v1

openenergyid-0.1.21/.github/workflows/ruff.yml

@@ -1,8 +0,0 @@
-name: Ruff
-on: [push, pull_request]
-jobs:
-  ruff:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: chartboost/ruff-action@v1

openenergyid-0.1.21/.gitignore

@@ -1,168 +0,0 @@
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
-
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-share/python-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-*.py,cover
-.hypothesis/
-.pytest_cache/
-cover/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-.pybuilder/
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
-# .python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# poetry
-#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
-
-# pdm
-#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
-#pdm.lock
-#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
-#   in version control.
-#   https://pdm.fming.dev/#use-with-ide
-.pdm.toml
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
-
-# pytype static type analyzer
-.pytype/
-
-# Cython debug symbols
-cython_debug/
-
-# PyCharm
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  and can be added to the global gitignore or merged into this file.  For a more nuclear
-#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
-.DS_Store
-secrets.json
-
-private_data/
-figures/
-temp_notebooks/
-*.pkl
-vis/

openenergyid-0.1.21/.pre-commit-config.yaml

@@ -1,43 +0,0 @@
-repos:
-  - repo: https://github.com/astral-sh/ruff-pre-commit
-    # Ruff version.
-    rev: v0.5.5
-    hooks:
-      # Run the linter.
-      - id: ruff
-        types_or: [python, pyi, jupyter]
-        args: [--fix]
-      # Run the formatter.
-      - id: ruff-format
-        types_or: [python, pyi, jupyter]
-
-  - repo: https://github.com/asottile/pyupgrade
-    rev: v3.16.0
-    hooks:
-      - id: pyupgrade
-        args: [--py311-plus]
-
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
-    hooks:
-      - id: mixed-line-ending
-        args: [--fix=lf] # Force LF line endings
-      - id: check-yaml
-      - id: end-of-file-fixer
-      - id: trailing-whitespace
-      - id: check-added-large-files
-
-  - repo: local
-    hooks:
-      - id: poetry-export-prod
-        name: Poetry export production requirements
-        entry: poetry export -f requirements.txt --output requirements.txt --without-hashes
-        language: system
-        pass_filenames: false
-        files: ^(pyproject\.toml|poetry\.lock)$
-      - id: poetry-export-dev
-        name: Poetry export development requirements
-        entry: poetry export -f requirements.txt --output requirements-dev.txt --without-hashes --only dev
-        language: system
-        pass_filenames: false
-        files: ^(pyproject\.toml|poetry\.lock)$

openenergyid-0.1.21/.vscode/settings.json

@@ -1,4 +0,0 @@
-{
-  "python.analysis.typeCheckingMode": "basic",
-  "remote.autoForwardPortsFallback": 0
-}

openenergyid-0.1.21/DEVELOPERS.md

@@ -1,63 +0,0 @@
-# Development Environment Setup
-
-This guide outlines the setup process for our development environment, focusing on packaging and dependency management.
-
-## Info on dev setup
-
-### Commit practices (pre-commit)
-
-we use [pre-commit ](https://pre-commit.com/)to run RUFF.
-
-### Poetry for Packaging and Dependency Management
-
-We use [Poetry](https://python-poetry.org/docs/main/#installation) as our primary tool for packaging and managing dependencies. Poetry provides a simple yet powerful way to manage project dependencies and publish packages.
-
-For the most detailed and up-to-date information, please refer to the [official Poetry 📚](https://python-poetry.org/docs/main/#installation).
-
-### Installing Python CLI Applications Globally with pipx
-
-To ensure that Python CLI applications are installed globally on your system while being isolated in their own virtual environments, we utilize `pipx`.
-
-## Steps to Install pipx and Poetry
-
-1. First, [install pipx](https://pipx.pypa.io/stable/installation/) following the instructions on the official website.
-2. Once pipx is installed, you can easily install Poetry by running the following command in your terminal:
-   `pipx install poetry`
-3. (_optional_) [install](vscode:extension/zeshuaro.vscode-python-poetry) vscode extension for poetry
-
-### Setup with Poetry
-
-```shell
-poetry install
-```
-
-### publishing with poetry
-
-https://python-poetry.org/docs/repositories/
-
-## Remarks for devcontainer
-
-You can also work inside a docker container(devcontainer).
-
-```bash
-whoami
-sudo chown -R $USER:$USER /workspaces/ -R
-```
-
-### some info about devcontainers:
-
-- [poetry in a devcontainer](https://marioscalas.medium.com/using-python-and-poetry-inside-a-dev-container-33c80bc5a22c)
-
-- [our python/container version](https://github.com/devcontainers/images/blob/main/src/python/history/1.1.9.md#variant-311-bookworm)
-
-- notes on [devcontainer git authentication](https://code.visualstudio.com/remote/advancedcontainers/sharing-git-credentials). dont forget to ssh-add if you use keys.
-
-# Useful commands for dev work
-
-## clean up
-
-[vulture](https://github.com/jendrikseipp/vulture) for finding dead python 🐍
-`pipx run vulture . --exclude venv`
-
-[deptry](https://github.com/fpgmaas/deptry) for checking dependencies
-`pipx run deptry . --ignore-notebooks`