bellande_step/README.md

105 lines
2.9 KiB
Markdown
Raw Normal View History

2024-01-29 03:44:59 +00:00
# 📦 Bellande Step
2024-04-25 03:02:15 +00:00
## BS(Bellande Step) Algorithm API
2024-01-29 00:43:38 +00:00
2024-03-18 05:33:59 +00:00
# Check Out Research Organization for open-source/semi-open-source API
- https://robotics-sensors.github.io
- Check out website for more information avaliable open-source API
2024-03-05 00:27:28 +00:00
2024-03-02 04:51:35 +00:00
# API in api_docs
2024-03-05 00:27:28 +00:00
- Temporarily Enabled
2024-03-18 05:33:59 +00:00
- 2D Space
- 3D Space
- 4D Space
- 5D Space
- 6D Space
- 7D Space
- 8D Space
- 9D Space
- 10D Space
2024-03-20 03:07:02 +00:00
# Can also checkout portion of the docs at [Portion API DOCS](https://github.com/Robotics-Sensors/bellande_robots_step/blob/main/api_docs.md)
2024-01-29 00:43:38 +00:00
### ✔️ confirmed versions
2024-01-29 03:44:59 +00:00
- `The step function efficiently computes the next step towards a target node within a specified distance limit.`
2024-01-29 05:59:37 +00:00
## Usage 2D Space
2024-01-29 03:44:59 +00:00
Suppose you have two nodes representing positions in a 2D space:
- `node0` at coordinates `(0, 0)`
- `node1` at coordinates `(5, 5)`
You want to compute the next step from `node0` towards `node1` while limiting the maximum distance to 3 units.
```python
2024-01-30 18:55:48 +00:00
# Define Import
2024-01-30 19:04:19 +00:00
from bellande_robot_step.bellande_robot_step_2d import bellande_step_2d, Node2D
2024-01-30 18:55:48 +00:00
2024-01-29 03:44:59 +00:00
# Define the nodes
2024-01-29 16:37:23 +00:00
node0 = Node2D(0, 0)
node1 = Node2D(5, 5)
2024-01-29 03:44:59 +00:00
# Compute the next step within a distance limit of 3 units
2024-01-29 05:49:36 +00:00
next_step = bellande_step_2d(node0, node1, limit=3)
2024-01-29 03:44:59 +00:00
# Output the coordinates of the next step
print("Next Step Coordinates:", next_step.coord)
```
## Usage 3D Space
Suppose you have two nodes representing positions in a 3D space:
- `node0` at coordinates `(0, 0, 0)`
- `node1` at coordinates `(5, 5, 5)`
You want to compute the next step from `node0` towards `node1` while limiting the maximum distance to 3 units.
```python
2024-01-30 18:55:48 +00:00
# Define Import
2024-01-30 20:32:30 +00:00
from bellande_robot_step.bellande_robot_step_3d import bellande_step_3d, Node3D
2024-01-30 18:55:48 +00:00
2024-01-29 03:44:59 +00:00
# Define the nodes
2024-01-29 16:37:23 +00:00
node0 = Node3D(0, 0, 0)
node1 = Node3D(5, 5, 5)
2024-01-29 03:44:59 +00:00
# Compute the next step within a distance limit of 3 units
2024-01-29 05:49:36 +00:00
next_step = bellande_step_3d(node0, node1, limit=3)
2024-01-29 03:44:59 +00:00
# Output the coordinates of the next step
print("Next Step Coordinates:", next_step.coord)
```
### Avaliable
- 2D Space
- 3D Space
- 4D Space
- 5D Space
- 6D Space
- 7D Space
- 8D Space
- 9D Space
- 10D Space
2024-01-29 00:43:38 +00:00
## Website
2024-03-02 04:51:35 +00:00
- https://pypi.org/project/bellande_robot_step
2024-01-29 00:43:38 +00:00
### Installation
- `$ pip install bellande_robot_step`
2024-01-30 19:04:19 +00:00
### Upgrade (if not upgraded)
- `$ pip install --upgrade bellande_robot_step`
2024-01-29 00:43:38 +00:00
```
Name: bellande_robot_step
2024-01-30 19:04:52 +00:00
Version: 0.3.0
2024-01-29 00:43:38 +00:00
Summary: Computes the next step towards a target node
Home-page: github.com/RonaldsonBellande/bellande_robot_step
Author: Ronaldson Bellande
Author-email: ronaldsonbellande@gmail.com
License: GNU General Public License v3.0
Requires: numpy
Required-by:
```
2024-04-25 03:02:15 +00:00
## License
This Algorithm or Models is distributed under the [Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/), see [LICENSE](https://github.com/RonaldsonBellande/bellande_robots_step/blob/main/LICENSE) and [NOTICE](https://github.com/RonaldsonBellande/bellande_robots_step/blob/main/LICENSE) for more information.