# EthicalGardeners
**EthicalGardeners** is a [PettingZoo](https://pettingzoo.farama.org/)
multi-agent environment for simulating gardeners tending to a grid-world
garden, including ethical considerations.
The goal is to make agents learn an ethically-aligned behaviour that includes
and respects these considerations.
## How to
### Run
To launch the simulation with default settings, use the following command in a shell, with the current
working directory being the project root:
```sh
python ethicalgardeners/main.py --config-name config
```
### Run tests
Tests must be placed in the `tests/` folder; files must follow the `test_*.py`
naming convention to be detected by unittest.
To run the tests, use the following command in a shell, with the current
working directory being the project root:
```sh
python -m unittest tests/test_*.py
```
### Build the docs
Documentation can be found in the `docs/` folder, and is built using Sphinx.
A quick command to build the documentation in the HTML format is:
```sh
cd docs/
make html
```
Then, open the `build/html/index.html` file in your favorite browser to read
the rendered docs.
Documentation has its own requirements, which can be installed with
```sh
pip install -r docs/requirements.txt
```
See the [documentation](https://ethicsai.github.io/ethical-gardeners/main/index.html) for more details.
Raw data
{
"_id": null,
"home_page": null,
"name": "ethical-gardeners",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "Gym, Gymnasium, Machine Ethics, Multi-Agent System, OpenAI Gym, Reinforcement Learning",
"author": "Enzo Dos Anjos",
"author_email": "R\u00e9my Chaput <rchaput.pro@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/c3/75/741d11a35ff707e509e302cfbe8a10403cd183d9d6738a1a6d611a17dd34/ethical_gardeners-0.0.1.tar.gz",
"platform": null,
"description": "# EthicalGardeners\n\n**EthicalGardeners** is a [PettingZoo](https://pettingzoo.farama.org/)\nmulti-agent environment for simulating gardeners tending to a grid-world\ngarden, including ethical considerations.\n\nThe goal is to make agents learn an ethically-aligned behaviour that includes\nand respects these considerations.\n\n\n## How to\n\n### Run\n\nTo launch the simulation with default settings, use the following command in a shell, with the current\nworking directory being the project root:\n\n```sh\npython ethicalgardeners/main.py --config-name config\n```\n\n### Run tests\n\nTests must be placed in the `tests/` folder; files must follow the `test_*.py`\nnaming convention to be detected by unittest.\n\nTo run the tests, use the following command in a shell, with the current\nworking directory being the project root:\n\n```sh\npython -m unittest tests/test_*.py\n```\n\n### Build the docs\n\nDocumentation can be found in the `docs/` folder, and is built using Sphinx.\nA quick command to build the documentation in the HTML format is:\n\n```sh\ncd docs/\nmake html\n```\n\nThen, open the `build/html/index.html` file in your favorite browser to read \nthe rendered docs.\n\nDocumentation has its own requirements, which can be installed with\n\n```sh\npip install -r docs/requirements.txt\n```\n\nSee the [documentation](https://ethicsai.github.io/ethical-gardeners/main/index.html) for more details.\n",
"bugtrack_url": null,
"license": null,
"summary": "A RL environment for learning ethically-aligned behaviours",
"version": "0.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/ethicsai/ethicalgardeners/issues",
"Documentation": "https://ethicsai.github.io/ethical-gardeners/",
"Source code": "https://github.com/ethicsai/ethicalgardeners"
},
"split_keywords": [
"gym",
" gymnasium",
" machine ethics",
" multi-agent system",
" openai gym",
" reinforcement learning"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b1e0298663d97d99cee2de762fd533b3369b6818ca778d12ca8b400116131362",
"md5": "5e7b34f0d87368c9fed2fd52404094a6",
"sha256": "b719abd63e56e87074c1e93de127262e4b2b1741b848e68962c184c6ebf92d98"
},
"downloads": -1,
"filename": "ethical_gardeners-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5e7b34f0d87368c9fed2fd52404094a6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 50297,
"upload_time": "2025-09-08T07:18:00",
"upload_time_iso_8601": "2025-09-08T07:18:00.569641Z",
"url": "https://files.pythonhosted.org/packages/b1/e0/298663d97d99cee2de762fd533b3369b6818ca778d12ca8b400116131362/ethical_gardeners-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c375741d11a35ff707e509e302cfbe8a10403cd183d9d6738a1a6d611a17dd34",
"md5": "cf565601f0ef6b60d226ff594b8b48df",
"sha256": "b909f9f169ff930d08f8ab96f9f2860de9b7c9c3ce5797774c95447fa924a9d6"
},
"downloads": -1,
"filename": "ethical_gardeners-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "cf565601f0ef6b60d226ff594b8b48df",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 40557,
"upload_time": "2025-09-08T07:18:02",
"upload_time_iso_8601": "2025-09-08T07:18:02.081960Z",
"url": "https://files.pythonhosted.org/packages/c3/75/741d11a35ff707e509e302cfbe8a10403cd183d9d6738a1a6d611a17dd34/ethical_gardeners-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-08 07:18:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ethicsai",
"github_project": "ethicalgardeners",
"github_not_found": true,
"lcname": "ethical-gardeners"
}
JSON
