10 Commits

Include renames

Author	SHA1	Message	Date
Bobby NoelteandGitHub	80bfe4d0f0	Improve caching. (#431) ... * Move the caching module to core. Add an in memory cache that for caching function and method results during an energy management run (optimization run). Two decorators are provided for methods and functions. * Improve the file cache store by load and save functions. Make EOS load the cache file store on startup and save it on shutdown. Add a cyclic task that cleans the cache file store from outdated cache files. * Improve startup of EOSdash by EOS Make EOS starting EOSdash adhere to path configuration given in EOS. The whole environment from EOS is now passed to EOSdash. Should also prevent test errors due to unwanted/ wrong config file creation. Both servers now provide a health endpoint that can be used to detect whether the server is running. This is also used for testing now. * Improve startup of EOS EOS now has got an energy management task that runs shortly after startup. It tries to execute energy management runs with predictions newly fetched or initialized from cached data on first run. * Improve shutdown of EOS EOS has now a shutdown task that shuts EOS down gracefully with some time delay to allow REST API requests for shutdwon or restart to be fully serviced. * Improve EMS Add energy management task for repeated energy management controlled by startup delay and interval configuration parameters. Translate EnergieManagementSystem to english EnergyManagement. * Add administration endpoints - endpoints to control caching from REST API. - endpoints to control server restart (will not work on Windows) and shutdown from REST API * Improve doc generation Use "\n" linenend convention also on Windows when generating doc files. Replace Windows specific 127.0.0.1 address by standard 0.0.0.0. * Improve test support (to be able to test caching) - Add system test option to pytest for running tests with "real" resources - Add new test fixture to start server for test class and test function - Make kill signal adapt to Windows/ Linux - Use consistently "\n" for lineends when writing text files in doc test - Fix test_logging under Windows - Fix conftest config_default_dirs test fixture under Windows From @Lasall * Improve Windows support - 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). - Update install/startup instructions as package installation is required atm. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>	2025-02-12 21:35:51 +01:00
Bobby NoelteandGitHub	9c91a64c1b	Fix EOSdash startup. (#394) ... 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
3 people	30cb51846d	EOS_DIR checks for an existing EOS.config.json (#378) ... Co-authored-by: Andre Busche <busche@ismll.de>	2025-01-14 13:27:30 +01:00
Bobby NoelteandGitHub	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
Bobby NoelteandGitHub	214768795f	Adapt documentation generation to be compliant to ReadTheDocs and Windows. (#341) ... Use documentation generation tools that are available for Windows and Linux. Use python instead of shell scripts to generate documentation. For ReadTheDocs make generated documentation content static to avoid running scripts outside of the docs/ path which is the default path for ReadTheDOcs. Add tests that check if generated content does go out of sync with latest source. Use tabs to show commands for Windows and Linux to improve user experience. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>	2025-01-06 16:27:57 +01:00
Bobby NoelteandGitHub	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
Dominique LasserreandGitHub	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
3 people	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
3 people	94467e1a69	Add API documentation generation and use Markdown (#160) ... * Add package API documentation generation Add generation of the API documentation for akkudoktoreos and akkudoktoreosserver packages. The API documentation is generated by the Sphinx autosummary extension. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> * Enable Google style source commenting and documentation generation. Enable automatic documentation generation from Google style docstrings in the source. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> * Check Google style source commenting. Check Google style commenting by the appropriate ruff rules. Commenting is _NOT_ enforced. Missing docstrings are ignored. Minor commenting quirks of the code base are adapted. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> * Improve Markdown handling and switch to Markdown documentation. Switch to Markdown for the documentation files to improve the user and developer experience (see issue #181). Keep files with special directives for automatic API documentation in RST format. The directives expect RST. Also add dummy handling for openai/ swagger server documentation. The openai interface definition is for now taken from the fastapi PR as EOS will switch to fastAPI. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> --------- Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> Co-authored-by: Normann <github@koldrack.com>	2024-11-10 23:27:52 +01:00
Bobby NoelteandAndreas	86639b9437	Add documentation infrastructure ... Add documentation infrastructure and some sample content. Documentation is generated by sphinx using extensions to support Markdown an restructuredText for simple documentation writing. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>	2024-10-10 15:22:34 +02:00