https://github.com/quentin18/line-track-designer
A library to design line following tracks for robots
https://github.com/quentin18/line-track-designer
following python robotics track
Last synced: 8 months ago
JSON representation
A library to design line following tracks for robots
- Host: GitHub
- URL: https://github.com/quentin18/line-track-designer
- Owner: Quentin18
- License: mit
- Created: 2020-06-22T13:46:39.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-30T23:41:41.000Z (over 2 years ago)
- Last Synced: 2025-08-30T18:47:23.320Z (9 months ago)
- Topics: following, python, robotics, track
- Language: Python
- Homepage: https://line-track-designer.readthedocs.io/en/latest/
- Size: 1.99 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Line Track Designer
[](https://line-track-designer.readthedocs.io/en/latest/?badge=latest)
[](https://travis-ci.org/Quentin18/Line-Track-Designer)
[](https://opensource.org/licenses/MIT)
*Line Track Designer* is a library to design line following tracks for robots. With this tool, you can easily **edit**, **save**, **share** and **print** your tracks with a printer.
Tracks can be created in two different ways:
- with the command line interface (CLI)
- with the application programming interface in Python (API)
It uses a PDF file containing tiles to build tracks: [PDF](https://github.com/Quentin18/Line-Track-Designer/blob/master/line_track_designer/pdf/linefollowtiles.pdf)
## Installation
*Line Track Designer* can be installed using [pip](https://pip.pypa.io/en/stable/):
```bash
pip3 install line-track-designer
```
## Quickstart
For example, we consider a file named ``track.txt``:
```
3;1 2;1 3;0
2;0 11;0 2;0
3;2 2;1 3;3
```
This file represents the following track:
This picture can be obtained with the following command:
```bash
linetrack show track.txt
```
You can also generate documentation for your track using this command:
```bash
linetrack savemd track.txt
```
It generates a markdown file with informations about the track. You can see an example [here](https://github.com/Quentin18/Line-Track-Designer/blob/master/docs/source/pdf/track.pdf).
You can also use the API to create tracks:
```python
import numpy as np
from line_track_designer.track import Track
# Arrays for the track
tiles = np.array([
[3, 2, 3],
[2, 11, 2],
[3, 2, 3]
])
orient = np.array([
[1, 1, 0],
[0, 0, 0],
[2, 1, 3]
])
# Creation of the track
track = Track(tiles, orient, 'Test track')
# Save the track
track.save_txt('track.txt')
# Make png file
track.save_img('track.png')
# Make markdown file
track.save_md('track.md', 'Easy track')
```
For more details, see the documentation [here](https://line-track-designer.readthedocs.io/en/latest/).
## Links
- GitHub: https://github.com/Quentin18/Line-Track-Designer/
- PyPI: https://pypi.org/project/line-track-designer/
- Documentation: https://line-track-designer.readthedocs.io/en/latest/
- Travis: https://travis-ci.org/github/Quentin18/Line-Track-Designer/
- PDF file's author: http://robotsquare.com/
## Author
Quentin Deschamps: quentindeschamps18@gmail.com
## License
[MIT](https://choosealicense.com/licenses/mit/)