| Name | nav2d JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | https://github.com/xxArbiter/nav2d |
| Summary | 2D Navigation Gym Environment |
| upload_time | 2023-12-03 06:07:50 |
| maintainer | |
| docs_url | None |
| author | Xiaoyu Wang |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2023 Xiauyo Wang 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 |
gym
navigation
rl
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 2D Navigation Gym Environment
This repository implements a [Gym](https://github.com/openai/gym) environment for simulating simple 2D navigation scenarios.
### Installation
Activate a virtual environment or a conda environment. Then, run the following command:
```
pip install nav2d
```
### Use cases
The building blocks in this toolbox are `Point`, `Vector`, and `Polygon` defined in `nav2d.assets.elements`.
- Point: `p = Point(x, y)`, `p.pos` is a `np.array`. You can add a `Vector` to a `Point` to make it a new `Point`.
- Vector: inherits from `Point`. You can apply various algebraic operations to `Vector`. Many operators are overloaded there, e.g., `sum(List[Vector])` gives you a singe `Vector`. `Vector` helps you manipulate multiple movements.
- Polygon: `zone = Polygon(List[Point])`. Given a zone and a point, `zone.point_relative_pos(p)` tells you their relative position `IN | ON | OUT`. A `Polygon` is defined by its vertices (`Point`s).
### Authors
[Xiaoyu Wang](https://www.linkedin.com/in/xiaoyu-wang-8b938b203/?originalSubdomain=ca)
[Jihwan Jeong](https://jihwan-jeong.netlify.app/)
Raw data
{
"_id": null,
"home_page": "https://github.com/xxArbiter/nav2d",
"name": "nav2d",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "gym,navigation,rl",
"author": "Xiaoyu Wang",
"author_email": "Xiaoyu Wang <cnxiaoyu.wang@mail.utoronto.ca>, Jihwan Jeong <jiihwan.jeong@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/df/2d/1c093b01dc6bbd924db0014d488523acc9fbe8e1af48b427ea0358702df6/nav2d-0.0.2.tar.gz",
"platform": null,
"description": "# 2D Navigation Gym Environment\n\nThis repository implements a [Gym](https://github.com/openai/gym) environment for simulating simple 2D navigation scenarios.\n\n### Installation\nActivate a virtual environment or a conda environment. Then, run the following command:\n```\npip install nav2d\n```\n\n### Use cases\nThe building blocks in this toolbox are `Point`, `Vector`, and `Polygon` defined in `nav2d.assets.elements`.\n\n- Point: `p = Point(x, y)`, `p.pos` is a `np.array`. You can add a `Vector` to a `Point` to make it a new `Point`.\n- Vector: inherits from `Point`. You can apply various algebraic operations to `Vector`. Many operators are overloaded there, e.g., `sum(List[Vector])` gives you a singe `Vector`. `Vector` helps you manipulate multiple movements.\n- Polygon: `zone = Polygon(List[Point])`. Given a zone and a point, `zone.point_relative_pos(p)` tells you their relative position `IN | ON | OUT`. A `Polygon` is defined by its vertices (`Point`s).\n\n### Authors\n\n[Xiaoyu Wang](https://www.linkedin.com/in/xiaoyu-wang-8b938b203/?originalSubdomain=ca)\n\n[Jihwan Jeong](https://jihwan-jeong.netlify.app/)\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Xiauyo Wang 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": "2D Navigation Gym Environment",
"version": "0.0.2",
"project_urls": {
"Bug Tracker": "https://github.com/xxArbiter/nav2d/issues",
"Download": "https://github.com/xxArbiter/nav2d/archive/refs/tags/0.0.2.tar.gz",
"Homepage": "https://github.com/xxArbiter/nav2d"
},
"split_keywords": [
"gym",
"navigation",
"rl"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8cd5afa55ff7415ba1f9696302088850a2696a8f80b49a23eccb1edd08682d7d",
"md5": "e48a749bf5455c3f63e6b8bb66bbce36",
"sha256": "d4c517aa14d45b63f41d4585fa7fb3495856916a01340357f41d365611db56e1"
},
"downloads": -1,
"filename": "nav2d-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e48a749bf5455c3f63e6b8bb66bbce36",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 13667,
"upload_time": "2023-12-03T06:07:48",
"upload_time_iso_8601": "2023-12-03T06:07:48.598183Z",
"url": "https://files.pythonhosted.org/packages/8c/d5/afa55ff7415ba1f9696302088850a2696a8f80b49a23eccb1edd08682d7d/nav2d-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "df2d1c093b01dc6bbd924db0014d488523acc9fbe8e1af48b427ea0358702df6",
"md5": "9d2105150710efd8b151c76f871991cd",
"sha256": "80b9d8cea47ddeac1b555f2c3a20ebdd0f80fee0e1b91e2e62a2612c7b115298"
},
"downloads": -1,
"filename": "nav2d-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "9d2105150710efd8b151c76f871991cd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 13353,
"upload_time": "2023-12-03T06:07:50",
"upload_time_iso_8601": "2023-12-03T06:07:50.561010Z",
"url": "https://files.pythonhosted.org/packages/df/2d/1c093b01dc6bbd924db0014d488523acc9fbe8e1af48b427ea0358702df6/nav2d-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-03 06:07:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "xxArbiter",
"github_project": "nav2d",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "nav2d"
}
