Metadata-Version: 2.1
Name: gctl
Version: 1.2
Summary: Generate curve tool
Author-email: Han Ruihua <hanrh@connect.hku.hk>
Project-URL: Homepage, https://github.com/hanruihua/GenerateCurveTool
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: scipy

# GenerateCurveTool

A tool of generating the common curves from way points for the robot path planning, including dubins path, reeds shepp, etc.


Dubins path  |   Reeds Shepp    |
:-------------------------:|:-------------------------:|
![](example/gif/dubins.gif)  | ![](example/gif/reeds_shepp.gif) 

## Prerequisite

- Python: >= 3.8
    - numpy  
    - matplotlib 

## Installation


You can simply install the package by pip:

```
pip install gctl
```

or install the development version by following command:

```
git clone https://github.com/hanruihua/GenerateCurveTool  
cd GenerateCurveTool  
pip install -e . 
```

## Usage 

The examples are in [GenerateCurveTool/example/](https://github.com/hanruihua/GenerateCurveTool/tree/main/example)

## Roadmap

- [x] Direct line
- [x] Dubins path
- [x] Reeds shepp
- [ ] bezier 

## Author

Han Ruihua  
Contact: hanrh@connect.hku.hk

