mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2026-01-01 00:06:18 +00:00
58d70e417b
Adapters for Home Assistant and NodeRED integration are added. Akkudoktor-EOS can now be run as Home Assistant add-on and standalone. As Home Assistant add-on EOS uses ingress to fully integrate the EOSdash dashboard in Home Assistant. The fix includes several bug fixes that are not directly related to the adapter implementation but are necessary to keep EOS running properly and to test and document the changes. * fix: development version scheme The development versioning scheme is adaptet to fit to docker and home assistant expectations. The new scheme is x.y.z and x.y.z.dev<hash>. Hash is only digits as expected by home assistant. Development version is appended by .dev as expected by docker. * fix: use mean value in interval on resampling for array When downsampling data use the mean value of all values within the new sampling interval. * fix: default battery ev soc and appliance wh Make the genetic simulation return default values for the battery SoC, electric vehicle SoC and appliance load if these assets are not used. * fix: import json string Strip outer quotes from JSON strings on import to be compliant to json.loads() expectation. * fix: default interval definition for import data Default interval must be defined in lowercase human definition to be accepted by pendulum. * fix: clearoutside schema change * feat: add adapters for integrations Adapters for Home Assistant and NodeRED integration are added. Akkudoktor-EOS can now be run as Home Assistant add-on and standalone. As Home Assistant add-on EOS uses ingress to fully integrate the EOSdash dashboard in Home Assistant. * feat: allow eos to be started with root permissions and drop priviledges Home assistant starts all add-ons with root permissions. Eos now drops root permissions if an applicable user is defined by paramter --run_as_user. The docker image defines the user eos to be used. * feat: make eos supervise and monitor EOSdash Eos now not only starts EOSdash but also monitors EOSdash during runtime and restarts EOSdash on fault. EOSdash logging is captured by EOS and forwarded to the EOS log to provide better visibility. * feat: add duration to string conversion Make to_duration to also return the duration as string on request. * chore: Use info logging to report missing optimization parameters In parameter preparation for automatic optimization an error was logged for missing paramters. Log is now down using the info level. * chore: make EOSdash use the EOS data directory for file import/ export EOSdash use the EOS data directory for file import/ export by default. This allows to use the configuration import/ export function also within docker images. * chore: improve EOSdash config tab display Improve display of JSON code and add more forms for config value update. * chore: make docker image file system layout similar to home assistant Only use /data directory for persistent data. This is handled as a docker volume. The /data volume is mapped to ~/.local/share/net.akkudoktor.eos if using docker compose. * chore: add home assistant add-on development environment Add VSCode devcontainer and task definition for home assistant add-on development. * chore: improve documentation
124 lines
4.1 KiB
TOML
124 lines
4.1 KiB
TOML
[project]
|
|
name = "akkudoktor-eos"
|
|
dynamic = ["version"] # Get version information dynamically
|
|
authors = [
|
|
{ name="Andreas Schmitz", email="author@example.com" },
|
|
]
|
|
description = "This project provides a comprehensive solution for simulating and optimizing an energy system based on renewable energy sources. With a focus on photovoltaic (PV) systems, battery storage (batteries), load management (consumer requirements), heat pumps, electric vehicles, and consideration of electricity price data, this system enables forecasting and optimization of energy flow and costs over a specified period."
|
|
readme = "README.md"
|
|
license = {file = "LICENSE"}
|
|
requires-python = ">=3.11"
|
|
classifiers = [
|
|
"Development Status :: 3 - Alpha",
|
|
"Programming Language :: Python :: 3",
|
|
"Operating System :: OS Independent",
|
|
]
|
|
|
|
[project.urls]
|
|
Homepage = "https://github.com/Akkudoktor-EOS/EOS"
|
|
Issues = "https://github.com/Akkudoktor-EOS/EOS/issues"
|
|
|
|
[build-system]
|
|
requires = ["setuptools>=61.0"]
|
|
build-backend = "setuptools.build_meta"
|
|
|
|
[tool.setuptools.dynamic]
|
|
dependencies = {file = ["requirements.txt"]}
|
|
optional-dependencies = {dev = { file = ["requirements-dev.txt"] }}
|
|
# version.txt must be generated
|
|
version = { file = "version.txt" }
|
|
|
|
[tool.setuptools.packages.find]
|
|
where = ["src/"]
|
|
include = ["akkudoktoreos"]
|
|
|
|
[tool.setuptools.package-data]
|
|
akkudoktoreos = ["*.json", "data/*.npz", ]
|
|
|
|
[tool.pyright]
|
|
# used in Pylance extension for language server
|
|
# type check is done by mypy, disable to avoid unwanted errors
|
|
typeCheckingMode = "off"
|
|
|
|
[tool.isort]
|
|
profile = "black"
|
|
|
|
[tool.ruff]
|
|
line-length = 100
|
|
exclude = [
|
|
"tests",
|
|
"scripts",
|
|
]
|
|
output-format = "full"
|
|
|
|
[tool.ruff.lint]
|
|
select = [
|
|
"F", # Enable all `Pyflakes` rules.
|
|
"D", # Enable all `pydocstyle` rules, limiting to those that adhere to the
|
|
# Google convention via `convention = "google"`, below.
|
|
"S", # Enable all `flake8-bandit` rules.
|
|
]
|
|
ignore = [
|
|
# Prevent errors due to ruff false positives
|
|
# ------------------------------------------
|
|
# On top of `Pyflakes (F)` to allow numpydantic Shape forward annotation
|
|
"F722", # forward-annotation-syntax-error: forward annotations that include invalid syntax.
|
|
|
|
# Prevent errors for existing sources. Should be removed!!!
|
|
# ---------------------------------------------------------
|
|
# On top of `Pyflakes (F)`
|
|
"F841", # unused-variable: Local variable {name} is assigned to but never used
|
|
# On top of `pydocstyle (D)`
|
|
"D100", # undocumented-public-module: Missing docstring in public module
|
|
"D101", # undocumented-public-class: Missing docstring in public class
|
|
"D102", # undocumented-public-method: Missing docstring in public method
|
|
"D103", # undocumented-public-function: Missing docstring in public function
|
|
"D104", # undocumented-public-package: Missing docstring in public package
|
|
"D105", # undocumented-magic-method: Missing docstring in magic method
|
|
"D106", # undocumented-public-nested-class: Missing docstring in public nested class
|
|
"D107", # undocumented-public-init: Missing docstring in __init__
|
|
"D417", # undocumented-param: Missing argument description in the docstring for {definition}: {name}
|
|
]
|
|
|
|
[tool.ruff.lint.pydocstyle]
|
|
convention = "google"
|
|
|
|
[tool.pytest.ini_options]
|
|
minversion = "8.3.3"
|
|
pythonpath = [ "src", ]
|
|
testpaths = [ "tests", ]
|
|
markers = [
|
|
"docker: marks tests that require a local Docker engine"
|
|
]
|
|
|
|
[tool.mypy]
|
|
files = ["src", "tests"]
|
|
exclude = "class_soc_calc\\.py$"
|
|
check_untyped_defs = true
|
|
warn_unused_ignores = true
|
|
|
|
[[tool.mypy.overrides]]
|
|
module = "akkudoktoreos.*"
|
|
disallow_untyped_defs = true
|
|
|
|
[[tool.mypy.overrides]]
|
|
module = "sklearn.*"
|
|
ignore_missing_imports = true
|
|
|
|
[[tool.mypy.overrides]]
|
|
module = "deap.*"
|
|
ignore_missing_imports = true
|
|
|
|
[[tool.mypy.overrides]]
|
|
module = "xprocess.*"
|
|
ignore_missing_imports = true
|
|
|
|
[tool.commitizen]
|
|
# Only used as linter
|
|
name = "cz_conventional_commits"
|
|
version_scheme = "semver"
|
|
|
|
# Enforce commit message and branch style:
|
|
branch_validation = true
|
|
branch_pattern = "^(feat|fix|chore|docs|refactor|test)/[a-z0-9._-]+$"
|