shrecc 0.0.1__tar.gz

shrecc-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright © 2024 Luxembourg Institute of Science and Technology
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

shrecc-0.0.1/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: shrecc
+Version: 0.0.1
+Summary: SHRECC: Smooth Hourly Resolution Electricity Consumption Calculation
+Author-email: Sabina Bednářová <sabina.bednarova@list.lu>
+Maintainer-email: Sabina Bednářová <sabina.bednarova@list.lu>
+Project-URL: source, https://git.list.lu/sabina.bednarova/SHRECC
+Project-URL: homepage, https://git.list.lu/sabina.bednarova/SHRECC
+Project-URL: tracker, https://git.list.lu/sabina.bednarova/SHRECC/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: bw2data
+Requires-Dist: pandas>=2
+Requires-Dist: numpy<2,>=1.24
+Requires-Dist: requests>=2.32
+Requires-Dist: fs
+Requires-Dist: scipy>=1.14
+Requires-Dist: appdirs
+Provides-Extra: testing
+Requires-Dist: shrecc; extra == "testing"
+Requires-Dist: pytest; extra == "testing"
+Requires-Dist: pytest-cov; extra == "testing"
+Requires-Dist: python-coveralls; extra == "testing"
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-randomly; extra == "dev"
+Requires-Dist: setuptools; extra == "dev"
+Dynamic: license-file
+
+# SHRECC: Simple Hourly Resolution Electricity Consumption Calculation
+
+## Description
+
+SHRECC package is a python package directly compatible with Brightway2 or Brightway2.5 to create time-aware electricity databases. For any given year and countries (check availability on https://api.energy-charts.info/), download and prepare data for low-voltage electricity consumption.
+
+## Features
+
+- **High-resolution electricity mixes** – Generates electricity life cycle inventories (LCIs) with **hourly** resolution, enhancing accuracy for life cycle assessment (LCA).
+- **Brightway2/2.5 compatibility** – Seamlessly integrates with Brightway, allowing direct use in existing LCA models.
+- **Dynamic temporal representation** – Users can select electricity mixes by **hour, month, or season**, addressing fluctuations in renewable energy generation and consumption.
+- **Automated data retrieval** – Pulls electricity production, trade, and consumption data from the **Energy Charts API**, ensuring up-to-date datasets.
+- **Ecoinvent matching** – Aligns with **ecoinvent classifications**, converting from ENTSO-E datasets.
+- **User-controlled updates** – Enables **one-time or recurring** updates, allowing continuous tracking of electricity mix evolution over time.
+- **Optimized impact assessments** – Helps reduce uncertainty and improve **decision-making for electricity-intensive technologies** by considering real-time electricity mix variations.
+
+## Installation
+
+### Clone the repository
+
+For the code: git clone [https://git.list.lu/shrecc_project/shrecc](https://git.list.lu/shrecc_project/shrecc)
+For the data: [https://git.list.lu/shrecc_project/shrecc_data](https://git.list.lu/shrecc_project/shrecc_data)
+
+### Install dependencies
+
+#### Using pip
+
+If you are using a standard Python environment, install dependencies with:
+` pip install -r requirements.txt`
+
+#### Using Conda environment
+
+If you prefer to use Conda, create an environment from the provided environment.yml file:
+`conda env create -f environment.yml`
+Then activate the environment: `conda activate shrecc`
+Alternatively, if the environment already exists and you want to update it: `conda env update --file environment.yml --prune`
+
+#### Using Conda environment (avoid Anaconda)
+
+If you prefer to use Conda and meanwhile avoid using Anaconda, create an environment from the provided environment_clean.yml file:
+`conda env create -f environment_clean.yml`
+
+Or, if you have Mamba installed (a faster Conda alternative):
+
+`mamba env create -f environment_clean.yml`
+Then activate the environment: `conda activate shrecc_clean`
+Alternatively, if the environment already exists and you want to update it: `conda env update --file environment_clean.yml --prune`
+
+Or, with Mamba:
+
+`mamba env update -n shrecc_clean -f environment.yml  `
+
+## Usage
+
+You can find usage examples in the Jupyter notebook: [notebooks/example.ipynb](notebooks/example.ipynb).
+
+## License
+
+Copyright © 2024 Luxembourg Institute of Science and Technology
+Licensed under the MIT License.
+
+## Authors
+
+* Sabina Bednářová (<sabina.bednarova@list.lu>)
+* Thomas Gibon (<thomas.gibon@list.lu>)

shrecc-0.0.1/README.md

@@ -0,0 +1,65 @@
+# SHRECC: Simple Hourly Resolution Electricity Consumption Calculation
+
+## Description
+
+SHRECC package is a python package directly compatible with Brightway2 or Brightway2.5 to create time-aware electricity databases. For any given year and countries (check availability on https://api.energy-charts.info/), download and prepare data for low-voltage electricity consumption.
+
+## Features
+
+- **High-resolution electricity mixes** – Generates electricity life cycle inventories (LCIs) with **hourly** resolution, enhancing accuracy for life cycle assessment (LCA).
+- **Brightway2/2.5 compatibility** – Seamlessly integrates with Brightway, allowing direct use in existing LCA models.
+- **Dynamic temporal representation** – Users can select electricity mixes by **hour, month, or season**, addressing fluctuations in renewable energy generation and consumption.
+- **Automated data retrieval** – Pulls electricity production, trade, and consumption data from the **Energy Charts API**, ensuring up-to-date datasets.
+- **Ecoinvent matching** – Aligns with **ecoinvent classifications**, converting from ENTSO-E datasets.
+- **User-controlled updates** – Enables **one-time or recurring** updates, allowing continuous tracking of electricity mix evolution over time.
+- **Optimized impact assessments** – Helps reduce uncertainty and improve **decision-making for electricity-intensive technologies** by considering real-time electricity mix variations.
+
+## Installation
+
+### Clone the repository
+
+For the code: git clone [https://git.list.lu/shrecc_project/shrecc](https://git.list.lu/shrecc_project/shrecc)
+For the data: [https://git.list.lu/shrecc_project/shrecc_data](https://git.list.lu/shrecc_project/shrecc_data)
+
+### Install dependencies
+
+#### Using pip
+
+If you are using a standard Python environment, install dependencies with:
+` pip install -r requirements.txt`
+
+#### Using Conda environment
+
+If you prefer to use Conda, create an environment from the provided environment.yml file:
+`conda env create -f environment.yml`
+Then activate the environment: `conda activate shrecc`
+Alternatively, if the environment already exists and you want to update it: `conda env update --file environment.yml --prune`
+
+#### Using Conda environment (avoid Anaconda)
+
+If you prefer to use Conda and meanwhile avoid using Anaconda, create an environment from the provided environment_clean.yml file:
+`conda env create -f environment_clean.yml`
+
+Or, if you have Mamba installed (a faster Conda alternative):
+
+`mamba env create -f environment_clean.yml`
+Then activate the environment: `conda activate shrecc_clean`
+Alternatively, if the environment already exists and you want to update it: `conda env update --file environment_clean.yml --prune`
+
+Or, with Mamba:
+
+`mamba env update -n shrecc_clean -f environment.yml  `
+
+## Usage
+
+You can find usage examples in the Jupyter notebook: [notebooks/example.ipynb](notebooks/example.ipynb).
+
+## License
+
+Copyright © 2024 Luxembourg Institute of Science and Technology
+Licensed under the MIT License.
+
+## Authors
+
+* Sabina Bednářová (<sabina.bednarova@list.lu>)
+* Thomas Gibon (<thomas.gibon@list.lu>)

shrecc-0.0.1/pyproject.toml

@@ -0,0 +1,110 @@
+[build-system]
+requires = ["setuptools>=68.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "shrecc"
+authors = [
+  { name="Sabina Bednářová", email="sabina.bednarova@list.lu" }
+]
+maintainers = [
+  { name="Sabina Bednářová", email="sabina.bednarova@list.lu" }
+]
+description = "SHRECC: Smooth Hourly Resolution Electricity Consumption Calculation"
+readme = "README.md"
+dynamic = ["version"]
+# Add here all kinds of additional classifiers as defined under
+# https://pypi.org/classifiers/
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Topic :: Scientific/Engineering"
+]
+requires-python = ">=3.10"
+dependencies = [
+    # dependencies as strings with quotes, e.g. "foo"
+    # You can add version requirements like "foo>2.0"
+   "bw2data",
+   "pandas>=2",
+   "numpy>=1.24,<2",
+   "requests>=2.32",
+   "fs",
+   "scipy>=1.14",
+   "appdirs",
+]
+
+[project.urls]
+source = "https://git.list.lu/sabina.bednarova/SHRECC"
+homepage = "https://git.list.lu/sabina.bednarova/SHRECC"
+tracker = "https://git.list.lu/sabina.bednarova/SHRECC/issues"
+
+[project.optional-dependencies]
+# Getting recursive dependencies to work is a pain, this
+# seems to work, at least for now
+testing = [
+    "shrecc",
+    "pytest",
+    "pytest-cov",
+    "python-coveralls"
+]
+dev = [
+    "build",
+    "pre-commit",
+    "pylint",
+    "pytest",
+    "pytest-cov",
+    "pytest-randomly",
+    "setuptools",
+]
+
+[tool.setuptools]
+license-files = ["LICENSE"]
+include-package-data = true
+packages = ["shrecc"]
+
+[tool.setuptools.dynamic]
+version = {attr = "shrecc.__version__"}
+
+[tool.pytest.ini_options]
+addopts = "--cov shrecc --cov-report term-missing --verbose"
+norecursedirs = [
+    "dist",
+    "build",
+    ".tox"
+]
+testpaths = ["tests/*.py"]
+
+[tool.flake8]
+# Some sane defaults for the code style checker flake8
+max_line_length = 88
+extend_ignore = ["E203", "W503"]
+# ^  Black-compatible
+#    E203 and W503 have edge cases handled by black
+exclude = [
+    ".tox",
+    "build",
+    "dist",
+    ".eggs",
+    "docs/conf.py",
+]
+
+[tool.black]
+line-length = 88
+
+[tool.isort]
+profile = "black"
+line_length = 88
+multi_line_output = 3
+include_trailing_comma = true
+force_grid_wrap = 0
+use_parentheses = true
+ensure_newline_before_comments = true
+
+[tool.pylint.format]
+max-line-length = "88"

shrecc-0.0.1/setup.cfg

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

shrecc-0.0.1/shrecc/__init__.py

@@ -0,0 +1,20 @@
+# Copyright © 2024 Luxembourg Institute of Science and Technology
+# Licensed under the MIT License (see LICENSE file for details).
+# Authors: [Sabina Bednářová, Thomas Gibon]
+
+
+"""shrecc"""
+
+__all__ = (
+    "__version__",
+    "create_database",
+    "filt_cutoff",
+    "get_data",
+    "data_processing",
+    "download_shrecc_data",
+)
+from .database import create_database, filt_cutoff
+from .download import get_data, download_shrecc_data
+from .treatment import data_processing
+
+__version__ = "0.0.1"