| Name | PyFlyt JSON |
| Version |
0.27.0
JSON |
| download |
| home_page | None |
| Summary | UAV Flight Simulator Gymnasium Environments for Reinforcement Learning Research. |
| upload_time | 2024-10-30 14:43:34 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
reinforcement learning
uavs
drones
quadcopter
ai
rl
gymnasium
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PyFlyt - UAV Flight Simulator for Reinforcement Learning
Comes with Gymnasium and PettingZoo environments built in!
<p align="center">
<img src="https://github.com/jjshoots/PyFlyt/blob/master/readme_assets/pyflyt_cover_photo.png?raw=true" width="600"/>
</p>
#### [View the documentation here!](https://jjshoots.github.io/PyFlyt/documentation.html)
This is a library for testing reinforcement learning algorithms on UAVs.
This repo is still under development.
We are also actively looking for users and developers, if this sounds like you, don't hesitate to get in touch!
## Installation
```sh
pip3 install wheel numpy
pip3 install pyflyt
```
> `numpy` and `wheel` must be installed prior to `pyflyt` such that `pybullet` is built with `numpy` support.
## Usage
Usage is similar to any other Gymnasium and PettingZoo environment:
### Gymnasium
```python
import gymnasium
import PyFlyt.gym_envs # noqa
env = gymnasium.make("PyFlyt/QuadX-Hover-v2", render_mode="human")
obs = env.reset()
termination = False
truncation = False
while not termination or truncation:
observation, reward, termination, truncation, info = env.step(env.action_space.sample())
```
View the official documentation for gymnasium environments [here](https://jjshoots.github.io/PyFlyt/documentation/gym_envs.html).
### PettingZoo
```python
from PyFlyt.pz_envs import MAFixedwingDogfightEnv
env = MAFixedwingDogfightEnv(render_mode="human")
observations, infos = env.reset()
while env.agents:
# this is where you would insert your policy
actions = {agent: env.action_space(agent).sample() for agent in env.agents}
observations, rewards, terminations, truncations, infos = env.step(actions)
env.close()
```
View the official documentation for pettingzoo environments [here](https://jjshoots.github.io/PyFlyt/documentation/pz_envs.html).
## Citation
If you use our work in your research and would like to cite it, please use the following bibtex entry:
```
@article{tai2023pyflyt,
title={PyFlyt--UAV Simulation Environments for Reinforcement Learning Research},
author={Tai, Jun Jet and Wong, Jim and Innocente, Mauro and Horri, Nadjim and Brusey, James and Phang, Swee King},
journal={arXiv preprint arXiv:2304.01305},
year={2023}
}
```
## Gallery
<p align="center">
<img src="https://github.com/jjshoots/PyFlyt/blob/master/readme_assets/fixedwing_waypoint.gif?raw=true" height="250px"/>
<img src="https://github.com/jjshoots/PyFlyt/blob/master/readme_assets/fixedwing_dogfight.gif?raw=true" height="250px"/>
</p>
<p align="center">
<img src="https://github.com/jjshoots/PyFlyt/blob/master/readme_assets/quadx_pole_waypoint.gif?raw=true" height="200px"/>
<img src="https://github.com/jjshoots/PyFlyt/blob/master/readme_assets/quadx_waypoint.gif?raw=true" height="200px"/>
<img src="https://github.com/jjshoots/PyFlyt/blob/master/readme_assets/quadx_ball_in_cup.gif?raw=true" height="200px"/>
</p>
Raw data
{
"_id": null,
"home_page": null,
"name": "PyFlyt",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "Reinforcement Learning, UAVs, drones, Quadcopter, AI, RL, Gymnasium",
"author": null,
"author_email": "Jet <taijunjet@hotmail.com>",
"download_url": "https://files.pythonhosted.org/packages/01/63/1efab402cbe29ad0d2abf7515a51ab62090ee0e54c7fdc6dc1d1cf9e28c3/pyflyt-0.27.0.tar.gz",
"platform": null,
"description": "# PyFlyt - UAV Flight Simulator for Reinforcement Learning\n\nComes with Gymnasium and PettingZoo environments built in!\n\n<p align=\"center\">\n <img src=\"https://github.com/jjshoots/PyFlyt/blob/master/readme_assets/pyflyt_cover_photo.png?raw=true\" width=\"600\"/>\n</p>\n\n#### [View the documentation here!](https://jjshoots.github.io/PyFlyt/documentation.html)\n\nThis is a library for testing reinforcement learning algorithms on UAVs.\nThis repo is still under development.\nWe are also actively looking for users and developers, if this sounds like you, don't hesitate to get in touch!\n\n## Installation\n\n```sh\npip3 install wheel numpy\npip3 install pyflyt\n```\n\n> `numpy` and `wheel` must be installed prior to `pyflyt` such that `pybullet` is built with `numpy` support.\n\n## Usage\n\nUsage is similar to any other Gymnasium and PettingZoo environment:\n\n### Gymnasium\n\n```python\nimport gymnasium\nimport PyFlyt.gym_envs # noqa\n\nenv = gymnasium.make(\"PyFlyt/QuadX-Hover-v2\", render_mode=\"human\")\nobs = env.reset()\n\ntermination = False\ntruncation = False\n\nwhile not termination or truncation:\n observation, reward, termination, truncation, info = env.step(env.action_space.sample())\n```\n\nView the official documentation for gymnasium environments [here](https://jjshoots.github.io/PyFlyt/documentation/gym_envs.html).\n\n### PettingZoo\n\n```python\nfrom PyFlyt.pz_envs import MAFixedwingDogfightEnv\n\nenv = MAFixedwingDogfightEnv(render_mode=\"human\")\nobservations, infos = env.reset()\n\nwhile env.agents:\n # this is where you would insert your policy\n actions = {agent: env.action_space(agent).sample() for agent in env.agents}\n\n observations, rewards, terminations, truncations, infos = env.step(actions)\nenv.close()\n```\n\nView the official documentation for pettingzoo environments [here](https://jjshoots.github.io/PyFlyt/documentation/pz_envs.html).\n\n## Citation\n\nIf you use our work in your research and would like to cite it, please use the following bibtex entry:\n\n```\n@article{tai2023pyflyt,\n title={PyFlyt--UAV Simulation Environments for Reinforcement Learning Research},\n author={Tai, Jun Jet and Wong, Jim and Innocente, Mauro and Horri, Nadjim and Brusey, James and Phang, Swee King},\n journal={arXiv preprint arXiv:2304.01305},\n year={2023}\n}\n```\n\n## Gallery\n\n<p align=\"center\">\n <img src=\"https://github.com/jjshoots/PyFlyt/blob/master/readme_assets/fixedwing_waypoint.gif?raw=true\" height=\"250px\"/>\n <img src=\"https://github.com/jjshoots/PyFlyt/blob/master/readme_assets/fixedwing_dogfight.gif?raw=true\" height=\"250px\"/>\n</p>\n<p align=\"center\">\n <img src=\"https://github.com/jjshoots/PyFlyt/blob/master/readme_assets/quadx_pole_waypoint.gif?raw=true\" height=\"200px\"/>\n <img src=\"https://github.com/jjshoots/PyFlyt/blob/master/readme_assets/quadx_waypoint.gif?raw=true\" height=\"200px\"/>\n <img src=\"https://github.com/jjshoots/PyFlyt/blob/master/readme_assets/quadx_ball_in_cup.gif?raw=true\" height=\"200px\"/>\n</p>\n",
"bugtrack_url": null,
"license": "MIT License Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "UAV Flight Simulator Gymnasium Environments for Reinforcement Learning Research.",
"version": "0.27.0",
"project_urls": {
"Bug Report": "https://github.com/jjshoots/PyFlyt/issues",
"Documentation": "https://jjshoots.github.io/PyFlyt/documentation.html",
"Repository": "https://github.com/jjshoots/PyFlyt"
},
"split_keywords": [
"reinforcement learning",
" uavs",
" drones",
" quadcopter",
" ai",
" rl",
" gymnasium"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d669c6c1cb38874483ee827cd744d5aa84f7ff4cc20059cb39f3662aebee3736",
"md5": "21fb8ca4a4c67b32c3c5578882a7a523",
"sha256": "3c51d1f6726e21fc49d51a8c0388dab1f8a3e05633c1e6fb1517beda3249bc5a"
},
"downloads": -1,
"filename": "PyFlyt-0.27.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "21fb8ca4a4c67b32c3c5578882a7a523",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 214536,
"upload_time": "2024-10-30T14:43:32",
"upload_time_iso_8601": "2024-10-30T14:43:32.769562Z",
"url": "https://files.pythonhosted.org/packages/d6/69/c6c1cb38874483ee827cd744d5aa84f7ff4cc20059cb39f3662aebee3736/PyFlyt-0.27.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "01631efab402cbe29ad0d2abf7515a51ab62090ee0e54c7fdc6dc1d1cf9e28c3",
"md5": "0c3f0ede04038b32938ac806be40b9e9",
"sha256": "37e50449289ceeb8597bbedcbc8654b306172a4a9ab317b83754c6d9f90d3ef0"
},
"downloads": -1,
"filename": "pyflyt-0.27.0.tar.gz",
"has_sig": false,
"md5_digest": "0c3f0ede04038b32938ac806be40b9e9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 183160,
"upload_time": "2024-10-30T14:43:34",
"upload_time_iso_8601": "2024-10-30T14:43:34.055174Z",
"url": "https://files.pythonhosted.org/packages/01/63/1efab402cbe29ad0d2abf7515a51ab62090ee0e54c7fdc6dc1d1cf9e28c3/pyflyt-0.27.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-30 14:43:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jjshoots",
"github_project": "PyFlyt",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pyflyt"
}
