# CorgiPath: Customizable Path Planner
![Python version](https://img.shields.io/badge/python-3.8+-blue)
[![License](https://img.shields.io/github/license/ryul1206/corgipath)](https://github.com/ryul1206/corgipath/blob/main/LICENSE)
Here is a simple flow chart:
```mermaid
flowchart LR
c("Collision Layer")
s("Search-space Layer")
plan("Planning Module")
post("Postprocessing Module\n(optional)")
v("Matplot Viewer\n(optional)")
c --> plan
s --> plan
plan -.-> post
plan -.-> v
post -.-> v
style c stroke:#f66,stroke-width:2px
style s stroke:#f66,stroke-width:2px
style plan stroke:#f66,stroke-width:2px
style post stroke-width:2px,stroke-dasharray: 5 5
style v stroke-width:2px,stroke-dasharray: 5 5
```
## Installation
<!-- ```sh
poetry build
``` -->
## Build your own planner
Development in vscode
```
poetry config virtualenvs.in-project true
poetry config virtualenvs.path "./.venv"
```
## Contribute
Thanks for taking the time to contribute!
- We recommend developing in [a virtual environment using Poetry](https://python-poetry.org/docs/basic-usage#using-your-virtual-environment).
Raw data
{
"_id": null,
"home_page": "https://github.com/ryul1206/corgipath",
"name": "corgipath",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8.1,<3.12",
"maintainer_email": "",
"keywords": "robotics,path-planning,hybrid-a-star",
"author": "Hong-ryul Jung",
"author_email": "jung.hr.1206@g.skku.edu",
"download_url": "",
"platform": null,
"description": "# CorgiPath: Customizable Path Planner\n\n![Python version](https://img.shields.io/badge/python-3.8+-blue)\n[![License](https://img.shields.io/github/license/ryul1206/corgipath)](https://github.com/ryul1206/corgipath/blob/main/LICENSE)\n\nHere is a simple flow chart:\n\n```mermaid\nflowchart LR\n\nc(\"Collision Layer\")\ns(\"Search-space Layer\")\n\nplan(\"Planning Module\")\npost(\"Postprocessing Module\\n(optional)\")\nv(\"Matplot Viewer\\n(optional)\")\n\nc --> plan\ns --> plan\n\nplan -.-> post\nplan -.-> v\npost -.-> v\n\nstyle c stroke:#f66,stroke-width:2px\nstyle s stroke:#f66,stroke-width:2px\nstyle plan stroke:#f66,stroke-width:2px\nstyle post stroke-width:2px,stroke-dasharray: 5 5\nstyle v stroke-width:2px,stroke-dasharray: 5 5\n```\n\n## Installation\n\n<!-- ```sh\npoetry build\n``` -->\n\n## Build your own planner\n\nDevelopment in vscode\n\n```\npoetry config virtualenvs.in-project true\npoetry config virtualenvs.path \"./.venv\"\n```\n\n## Contribute\n\nThanks for taking the time to contribute!\n\n- We recommend developing in [a virtual environment using Poetry](https://python-poetry.org/docs/basic-usage#using-your-virtual-environment).\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Customizable path planner",
"version": "0.1.0a1",
"project_urls": {
"Bug Tracker": "https://github.com/ryul1206/corgipath/issues",
"Homepage": "https://github.com/ryul1206/corgipath",
"Repository": "https://github.com/ryul1206/corgipath"
},
"split_keywords": [
"robotics",
"path-planning",
"hybrid-a-star"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f927b8ed44d66a756d5b877c8eadf978480a8ed82ccabe95ebfc34ff0e653995",
"md5": "26fdaa708a5be8109b831c0a1b533249",
"sha256": "81ea12fd5bfbe060f991b5e66bb3aebac853a3ddb2f6af8a15b617e77cca6c77"
},
"downloads": -1,
"filename": "corgipath-0.1.0a1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "26fdaa708a5be8109b831c0a1b533249",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1,<3.12",
"size": 21569,
"upload_time": "2023-08-21T18:19:11",
"upload_time_iso_8601": "2023-08-21T18:19:11.075825Z",
"url": "https://files.pythonhosted.org/packages/f9/27/b8ed44d66a756d5b877c8eadf978480a8ed82ccabe95ebfc34ff0e653995/corgipath-0.1.0a1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-21 18:19:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ryul1206",
"github_project": "corgipath",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "corgipath"
}