Metadata-Version: 2.1
Name: corgipath
Version: 0.1.0a1
Summary: Customizable path planner
Home-page: https://github.com/ryul1206/corgipath
License: MIT
Keywords: robotics,path-planning,hybrid-a-star
Author: Hong-ryul Jung
Author-email: jung.hr.1206@g.skku.edu
Requires-Python: >=3.8.1,<3.12
Classifier: Framework :: Robot Framework :: Library
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: aabbtree (>=2.8.1,<3.0.0)
Requires-Dist: collision (>=1.2.2,<2.0.0)
Requires-Dist: matplotlib (>=3.6.3,<4.0.0)
Requires-Dist: numpy (>=1.24.1,<2.0.0)
Requires-Dist: pillow (>=9.4.0,<10.0.0)
Requires-Dist: scipy (>=1.10.0,<2.0.0)
Requires-Dist: shapely (>=2.0.0,<3.0.0)
Project-URL: Bug Tracker, https://github.com/ryul1206/corgipath/issues
Project-URL: Repository, https://github.com/ryul1206/corgipath
Description-Content-Type: text/markdown

# 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).

