Mirrors/EOS
1
0
Fork 0
mirror of https://github.com/Akkudoktor-EOS/EOS.git synced 2025-04-19 08:55:15 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Change required python version to 3.10 (#297)
Some checks are pending
pre-commit / pre-commit (push) Waiting to run
Details
Run Pytest on Pull Request / test (push) Waiting to run
Details

Browse Source
This commit is contained in:
wenzul 2025-01-01 12:33:39 +01:00 committed by GitHub
parent 9dda128caf
commit 36916f71b4
2 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -11,7 +11,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md).
## Installation ## Installation
The project requires Python 3.9 or newer. Currently there are no official packages or images published. The project requires Python 3.10 or newer. Currently there are no official packages or images published.
Following sections describe how to locally start the EOS server on `http://localhost:8503`. Following sections describe how to locally start the EOS server on `http://localhost:8503`.
@ -20,12 +20,14 @@ Following sections describe how to locally start the EOS server on `http://local
Install dependencies in virtual environment: Install dependencies in virtual environment:
Linux: Linux:
```bash ```bash
python -m venv .venv python -m venv .venv
.venv/bin/pip install -r requirements.txt .venv/bin/pip install -r requirements.txt
``` ```
Windows: Windows:
```bash ```bash
python -m venv .venv python -m venv .venv
.venv\Scripts\pip install -r requirements.txt .venv\Scripts\pip install -r requirements.txt
@ -34,13 +36,17 @@ python -m venv .venv
Finally, start EOS fastapi server: Finally, start EOS fastapi server:
Linux: Linux:
```bash ```bash
.venv/bin/fastapi run --port 8503 src/akkudoktoreos/server/fastapi_server.py .venv/bin/fastapi run --port 8503 src/akkudoktoreos/server/fastapi_server.py
``` ```
Windows: Windows:
``` ```
.venv\Scripts\fastapi run --port 8503 src/akkudoktoreos/server/fastapi_server.py .venv\Scripts\fastapi run --port 8503 src/akkudoktoreos/server/fastapi_server.py
``` ```
### Docker ### Docker
```bash ```bash
@ -92,7 +98,6 @@ Each class is designed to be easily customized and extended to integrate additio
See the Swagger API documentation for detailed information: [EOS OpenAPI Spec](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/docs/akkudoktoreos/openapi.json) See the Swagger API documentation for detailed information: [EOS OpenAPI Spec](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/docs/akkudoktoreos/openapi.json)
## Further resources ## Further resources
- [Installation guide (de)](https://meintechblog.de/2024/09/05/andreas-schmitz-joerg-installiert-mein-energieoptimierungssystem/) - [Installation guide (de)](https://meintechblog.de/2024/09/05/andreas-schmitz-joerg-installiert-mein-energieoptimierungssystem/)

2
pyproject.toml
View File

@ -7,7 +7,7 @@ authors = [
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." 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" readme = "README.md"
license = {file = "LICENSE"} license = {file = "LICENSE"}
requires-python = ">=3.9" requires-python = ">=3.10"
classifiers = [ classifiers = [
"Development Status :: 3 - Alpha", "Development Status :: 3 - Alpha",
"Programming Language :: Python :: 3", "Programming Language :: Python :: 3",