<img src="./docs/images/logos/agentlib_logo/logo.svg" alt="drawing" height="150"/>
[](https://opensource.org/licenses/BSD-3-Clause)
[](https://rwth-ebc.github.io/AgentLib/main/coverage/)
[](https://rwth-ebc.github.io/AgentLib/main/pylint/pylint.html)
[](https://rwth-ebc.github.io/AgentLib/main/docs/index.html)
This is a collection of base classes for the implementation of agents in Python.
The original purpose of this library is the execution of distributed simulations and controllers for energy systems, however it is not limited to any specific field.
To get started, please check out our examples.
### Installation
To install the agentlib with minimal dependencies, run:
```
pip install agentlib
```
To install with full dependencies (recommended), run:
```
pip install agentlib[full]
```
If you want to work on the agentlib, first clone it, go its directory and then install it in editable mode:
```
pip install -e .[full]
```
## Optional Dependencies
The AgentLib has a number of optional dependencies, ranging from additional features to performance improvements:
- **fmu**: Support simulation of FMU models (https://fmi-standard.org/).
- **scipy**: Support simulation of linear state space models, based on scipy.
- **mqtt**: Support communication between agents through the mqtt protocol.
- **plot**: Installs matplotlib, allows to plot the result of examples.
- **orjson**: Faster json library, improves performance when using network communicators.
- **fuzz**: Improves error messages when providing wrong configurations.
**clonemap**: Support the execution of agents and their communication through [clonemap](https://github.com/sogno-platform/clonemap). As clonemapy is not available through PYPI, please install it from source, or through the AgentLib's ``requirements.txt`` .
## Referencing the AgentLib
A publication regarding the AgentLib is currently in the work.
A preprint is available under http://dx.doi.org/10.2139/ssrn.4884846 and can be cited as:
> Eser, Steffen and Storek, Thomas and Wüllhorst, Fabian and Dähling, Stefan and Gall, Jan and Stoffel, Phillip and Müller, Dirk, A Modular Python Framework for Rapid Development of Advanced Control Algorithms for Energy Systems. Available at SSRN: https://ssrn.com/abstract=4884846 or http://dx.doi.org/10.2139/ssrn.4884846
## Copyright and license
This project is licensed under the BSD 3 Clause License - see the [LICENSE](LICENSE) file for details.
## Acknowledgments
We gratefully acknowledge the financial support by Federal Ministry \\ for Economic Affairs and Climate Action (BMWK), promotional references 03ET1495A and 03EN1006A.
<img src="./docs/images/logos/BMWK_logo.png" alt="BMWK" width="200"/>
Raw data
{
"_id": null,
"home_page": null,
"name": "agentlib",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "agents, modular, control, distributed, digital twin",
"author": null,
"author_email": "Associates of the AGENT project <AGENT.Projekt@eonerc.rwth-aachen.de>",
"download_url": "https://files.pythonhosted.org/packages/1d/0b/8b9b413910d3a6afba058465b18e6314b04fee1610eb36c3a8bbb0415cb6/agentlib-0.8.5.tar.gz",
"platform": null,
"description": "<img src=\"./docs/images/logos/agentlib_logo/logo.svg\" alt=\"drawing\" height=\"150\"/>\n\n\n[](https://opensource.org/licenses/BSD-3-Clause)\n[](https://rwth-ebc.github.io/AgentLib/main/coverage/)\n[](https://rwth-ebc.github.io/AgentLib/main/pylint/pylint.html)\n[](https://rwth-ebc.github.io/AgentLib/main/docs/index.html)\n\n\nThis is a collection of base classes for the implementation of agents in Python.\nThe original purpose of this library is the execution of distributed simulations and controllers for energy systems, however it is not limited to any specific field.\nTo get started, please check out our examples.\n\n### Installation\n\nTo install the agentlib with minimal dependencies, run:\n\n```\npip install agentlib\n```\n\nTo install with full dependencies (recommended), run:\n```\npip install agentlib[full]\n```\n\nIf you want to work on the agentlib, first clone it, go its directory and then install it in editable mode:\n\n```\npip install -e .[full]\n```\n\n## Optional Dependencies\nThe AgentLib has a number of optional dependencies, ranging from additional features to performance improvements:\n \n - **fmu**: Support simulation of FMU models (https://fmi-standard.org/).\n - **scipy**: Support simulation of linear state space models, based on scipy.\n - **mqtt**: Support communication between agents through the mqtt protocol.\n - **plot**: Installs matplotlib, allows to plot the result of examples.\n - **orjson**: Faster json library, improves performance when using network communicators.\n - **fuzz**: Improves error messages when providing wrong configurations.\n\n**clonemap**: Support the execution of agents and their communication through [clonemap](https://github.com/sogno-platform/clonemap). As clonemapy is not available through PYPI, please install it from source, or through the AgentLib's ``requirements.txt`` .\n\n## Referencing the AgentLib\n\nA publication regarding the AgentLib is currently in the work.\nA preprint is available under http://dx.doi.org/10.2139/ssrn.4884846 and can be cited as: \n\n> Eser, Steffen and Storek, Thomas and W\u00fcllhorst, Fabian and D\u00e4hling, Stefan and Gall, Jan and Stoffel, Phillip and M\u00fcller, Dirk, A Modular Python Framework for Rapid Development of Advanced Control Algorithms for Energy Systems. Available at SSRN: https://ssrn.com/abstract=4884846 or http://dx.doi.org/10.2139/ssrn.4884846 \n\n## Copyright and license\n\nThis project is licensed under the BSD 3 Clause License - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\nWe gratefully acknowledge the financial support by Federal Ministry \\\\ for Economic Affairs and Climate Action (BMWK), promotional references 03ET1495A and 03EN1006A.\n\n<img src=\"./docs/images/logos/BMWK_logo.png\" alt=\"BMWK\" width=\"200\"/>\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Framework for development and execution of agents for control and simulation of energy systems.",
"version": "0.8.5",
"project_urls": null,
"split_keywords": [
"agents",
" modular",
" control",
" distributed",
" digital twin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e326ae41ec259408d9be64eded526852ad41ede88d87155f6ad7204e3bf3c3bb",
"md5": "6b88182b7ab1abab03f197972b5a086b",
"sha256": "2c28afd481c7e98fa2bdf753aad4e9c3c2c64e09cc25c039915b45abb5ea86f9"
},
"downloads": -1,
"filename": "agentlib-0.8.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6b88182b7ab1abab03f197972b5a086b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 92547,
"upload_time": "2024-11-19T08:15:34",
"upload_time_iso_8601": "2024-11-19T08:15:34.418834Z",
"url": "https://files.pythonhosted.org/packages/e3/26/ae41ec259408d9be64eded526852ad41ede88d87155f6ad7204e3bf3c3bb/agentlib-0.8.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1d0b8b9b413910d3a6afba058465b18e6314b04fee1610eb36c3a8bbb0415cb6",
"md5": "b99904332be555b9b02f34203ed52225",
"sha256": "de2918b430f28fb1d1a804fc15dd1509c5d9eb8cc398c6c9b788f4223b86458d"
},
"downloads": -1,
"filename": "agentlib-0.8.5.tar.gz",
"has_sig": false,
"md5_digest": "b99904332be555b9b02f34203ed52225",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4878262,
"upload_time": "2024-11-19T08:15:40",
"upload_time_iso_8601": "2024-11-19T08:15:40.770392Z",
"url": "https://files.pythonhosted.org/packages/1d/0b/8b9b413910d3a6afba058465b18e6314b04fee1610eb36c3a8bbb0415cb6/agentlib-0.8.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-19 08:15:40",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "agentlib"
}
JSON