49 Commits

Author SHA1 Message Date
Dominique Lasserre
b380624c9f
Windows: Fix EOSdash startup Closes #436 #447 (#450)
Some checks failed
docker-build / platform-excludes (push) Has been cancelled
pre-commit / pre-commit (push) Has been cancelled
Run Pytest on Pull Request / test (push) Has been cancelled
docker-build / build (push) Has been cancelled
docker-build / merge (push) Has been cancelled
* On Windows use 127.0.0.1 as default config host (model defaults) and
   addionally redirect 0.0.0.0 to localhost on Windows (because default
   config file still has 0.0.0.0).
   Use 0.0.0.0 as default otherwise (e.g. Linux/Docker) to allow EOS
   being accessible on local network (not just same host).
   Note: Docs generation on Windows is incompatible with the Github
   pipeline tests. Address this in the nested-config feature branch.
 * Update install/startup instructions as package installation is
   required atm and Docker on Windows has to be accessed at localhost or
   127.0.0.1 even though the server log says 0.0.0.0 (which is required
   to be available outside the container).
 * Fix EOSdash startup with read_only: true (support session key via
   EOS_SERVER__EOSDASH_SESSKEY variable). Backport of feature branch.
 * Remove root_path, causing Windows to fail load swagger UI (/docs).
2025-02-10 00:38:35 +01:00
Dominique Lasserre
29cf3a3174
README.md: Add some system requirements (#438)
Some checks failed
docker-build / platform-excludes (push) Has been cancelled
pre-commit / pre-commit (push) Has been cancelled
Run Pytest on Pull Request / test (push) Has been cancelled
docker-build / build (push) Has been cancelled
docker-build / merge (push) Has been cancelled
2025-02-01 20:46:00 +01:00
Bobby Noelte
9c91a64c1b
Fix EOSdash startup. (#394)
Some checks are pending
docker-build / platform-excludes (push) Waiting to run
docker-build / build (push) Blocked by required conditions
docker-build / merge (push) Blocked by required conditions
pre-commit / pre-commit (push) Waiting to run
Run Pytest on Pull Request / test (push) Waiting to run
Revert to EOSdash startup as a sub-process.
Add arguments to control the complete startup of both servers.
Also development reload can now be given as an argument.

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2025-01-21 19:20:50 +01:00
Dominique Lasserre
b6111517ca
workflow: docker-build upload to DockerHub (#318) (#363)
Some checks are pending
docker-build / platform-excludes (push) Waiting to run
docker-build / build (push) Blocked by required conditions
docker-build / merge (push) Blocked by required conditions
* workflow: docker-build upload to DockerHub
   - Upload on release, tag, push to main.
   - Build on pr to main (amd64 only).
 * docker:
   - Update documentation.
   - Temporarily set akkudoktor/eos:main in compose.yml (with
     releases/tags it should be replaced by latest again)
2025-01-12 00:52:42 +01:00
Bobby Noelte
34d8e88771
Rename FastAPI server to EOS. (#355)
Rename FastAPI server to `eos` and FastHTML server to `eosdash`.

Make an user easily identify what server is meant. FastAPI and FastHTML are
implementation details that may confuse the non-technical user.

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2025-01-09 16:54:49 +01:00
Dominique Lasserre
10acc705ec
Initial readthedocs config (#339)
* Add links to documentation.
 * Drop unused file class_soc_calc.
2025-01-06 19:34:15 +01:00
Bobby Noelte
1866055478
Add documentation. (#321)
Add documentation that covers:

- Prediction
- Measuremnt
- REST API

Add Python scripts that support automatic documentation generation using the Sphinx
sphinxcontrib.eval extension.

Add automatic update/ test for REST API documentation.

Filter proxy endpoints from REST API documentation.

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2025-01-03 00:31:20 +01:00
Normann
45079ca29c python version 3.10 for feature branch (#298)
* switch to python version 3.10 from 3.9 because of Numpy requirements
2024-12-30 14:26:12 +01:00
Normann
5f898e8aab translation of battery.py v3 (#262) 2024-12-19 14:50:19 +01:00
Andreas
daffcddbf4 Update README.md
Windows Description
2024-12-11 06:35:43 +01:00
Andreas
39d366dd2d Update README.md (#232)
Windows venv paths updated
2024-12-11 00:33:52 +01:00
Dominique Lasserre
edfe309a26 Update README/CONTRIBUTING Closes #180 (#204)
* Update README/CONTRIBUTING Closes #180

 * Remove duplicated files in docs/develop and copy them from project
   root to there on documentation generation.

* Makefile: Use fastapi to start server, set port to 8503
2024-11-17 15:27:43 +01:00
Dominique Lasserre
69212c3cff Update startup instructions. Closes #201 (#202) 2024-11-16 20:35:09 +01:00
Dominique Lasserre
f61665669f Migrate from Flask to FastAPI (#163)
* Migrate from Flask to FastAPI

 * FastAPI migration:
    - Use pydantic model classes as input parameters to the
      data/calculation classes.
    - Interface field names changed to constructor parameter names (for
      simplicity only during transition, should be updated in a followup
      PR).
    - Add basic interface requirements (e.g. some values > 0, etc.).
 * Update tests for new data format.
 * Python requirement down to 3.9 (TypeGuard no longer needed)
 * Makefile: Add helpful targets (e.g. development server with reload)

* Move API doc from README to pydantic model classes (swagger)

 * Link to swagger.io with own openapi.yml.
 * Commit openapi.json and check with pytest for changes so the
   documentation is always up-to-date.

* Streamline docker

* FastAPI: Run startup action on dev server

 * Fix config for /strompreis, endpoint still broken however.

* test_openapi: Compare against docs/.../openapi.json

* Move fastapi to server/ submodule

 * See #187 for new repository structure.
2024-11-15 22:27:25 +01:00
Chris
ed3226e522 Json configuration (#141)
* Add json config
* Adjust code to new config

---------

Co-authored-by: Chris <git@nootch.de>
2024-11-11 21:38:13 +01:00
Chris
de9fe2ddc9 Add settings and extension recommendations (#139)
- Added recommended settings for the Pylance and Pyright extensions
- Enabled pytest and debugging support in configuration
- Reformatted code with Prettier
---------
Co-authored-by: Chris <git@nootch.de>
2024-11-10 23:00:16 +01:00
Normann
0526f2417b Update README.md
clarify the None/Null/NaN values of the output.
2024-10-09 17:03:05 +02:00
BerndCzech
7156aed85a refactor: remove README-DE.md 2024-10-09 17:02:16 +02:00
Normann
4e0e363ba5 README.md Python req. pushed to 3.10 2024-10-08 07:53:07 +02:00
fortrieb
66d101fb50 Heat pump: Tests, Translation, Docstrings, Relocation (#89)
* Add first unit test for heatpump COP calculation

* Translate to english,

add type hints, improve unit tests.

* Run pre-commit

* Apply suggestions from code review

Co-authored-by: Michael Osthege <michael.osthege@outlook.com>

* Remove conftest file

---------

Co-authored-by: Michael Osthege <michael.osthege@outlook.com>
2024-10-06 01:06:08 +02:00
Michael Osthege
7abee4a8e8 Add contribution guide and issue templates 2024-10-04 11:51:10 +02:00
Michael Osthege
c3f10df277 Manual edits to remove remaining code style errors 2024-10-03 17:28:49 +02:00
Michael Osthege
3045d53bd6 Apply isort and ruff code style 2024-10-03 17:28:49 +02:00
Fortrieb
af7b745d15 Add english translation for readme.
Moving german readme to READEME-DE.md. Add sensible gitignore defaults for most operating systems, VS code and Python.
2024-09-30 08:02:40 +02:00
drbacke
d5c7d07363 Update README.md
TODOs entfernt und als Issues.
2024-09-16 16:20:07 +02:00
Daniel Molkentin
f250949497 Mitmachen-Sektion mit Anlaufstellen in die README.dm eingefügt 2024-09-16 09:25:40 +02:00
Daniel Molkentin
e54f14bea1 feat: add documentation, enable makefile driven usage
This introduces a One-Stop-Shop Makefile.

Also brings back tensorflow as dependency, it is still needed
2024-09-13 08:01:25 +02:00
Daniel Molkentin
c9bf0ecd36 feat: Detailliertere README 2024-09-10 19:42:35 +02:00
drbacke
acbe2e46f0 Update README.md 2024-09-06 09:56:36 +02:00
drbacke
004d69f35b Update README.md 2024-09-06 07:05:04 +02:00
Bla Bla
004b16c2fd Gesamtlast_simple 2024-09-05 14:26:26 +02:00
drbacke
4f14b3d25a Update README.md 2024-09-04 08:43:07 +02:00
drbacke
b5d61bd527 Update README.md 2024-09-04 08:42:45 +02:00
drbacke
1ffa0a4355 Update README.md 2024-08-02 14:04:37 +02:00
drbacke
6b3a6b5cb8 Update README.md 2024-07-30 18:19:03 +02:00
drbacke
275e598152 Update README.md 2024-07-30 13:39:27 +02:00
drbacke
0428ec2906 Update README.md 2024-07-30 13:35:53 +02:00
drbacke
ea68de70fb Update README.md 2024-07-30 13:31:57 +02:00
Bla Bla
95b0ec5664 48 Stunden Predcition & Optimierung
Ein paar Zeitfunktionen korrigiert (24h / 48h)
Strompreis Cache stündlich leeren
Strompreis bei nur 24h Daten, wird verdoppelt (Prognose fehlt noch)
2024-05-08 09:58:41 +02:00
Bla Bla
ef9d52a8eb AC Charge TODO
# Please enter the commit message for your changes. Lines starting
2024-04-28 10:28:34 +02:00
drbacke
f59020ab83 Update README.md 2024-04-17 17:56:17 +02:00
Bla Bla
347b096521 PV API eingefügPV API eingefügtt # Please enter the commit message for
your changes. Lines starting #
with '#' will be ignored, and an empty message aborts the commit.  # #
On branch main # Your branch is up to date with 'origin/main'.
2024-04-17 15:35:43 +02:00
Bla Bla
0dd766e8a6 Flask Server 2024-03-29 08:27:39 +01:00
drbacke
6e5ef83e32 Update README.md 2024-03-25 14:43:13 +01:00
drbacke
5afa192024 Update README.md 2024-03-09 09:28:29 +01:00
drbacke
8e6ac38936 Update README.md 2024-03-09 09:27:17 +01:00
drbacke
bb11310608 Update README.md 2024-03-03 18:28:24 +01:00
drbacke
4302cb9ffe Update README.md 2024-03-03 18:26:30 +01:00
drbacke
161b482a4a Create README.md 2024-03-03 18:23:29 +01:00