more description
This commit is contained in:
58
README.md
58
README.md
@ -1,19 +1,69 @@
|
|||||||
# 📦 bellande_robot_step
|
# 📦 Bellande Step
|
||||||
[](https://badge.fury.io/py/bellande_robot_step)
|
[](https://badge.fury.io/py/bellande_robot_step)
|
||||||
|
|
||||||
### 🦾 motivation
|
### 🦾 motivation
|
||||||
- easy to use package to solve an easy problem
|
- easy to use package to solve an easy problem
|
||||||
|
|
||||||
### ✔️ confirmed versions
|
### ✔️ confirmed versions
|
||||||
- `The step function efficiently computes the next step towards a target node within a specified distance limit.'
|
- `The step function efficiently computes the next step towards a target node within a specified distance limit.`
|
||||||
|
|
||||||
|
### Usage 2D Space
|
||||||
|
|
||||||
|
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
|
||||||
|
# Define the nodes
|
||||||
|
node0 = Node(0, 0)
|
||||||
|
node1 = Node(5, 5)
|
||||||
|
|
||||||
|
# Compute the next step within a distance limit of 3 units
|
||||||
|
next_step = step_from_to(node0, node1, limit=3)
|
||||||
|
|
||||||
|
# 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
|
||||||
|
# Define the nodes
|
||||||
|
node0 = Node(0, 0, 0)
|
||||||
|
node1 = Node(5, 5, 5)
|
||||||
|
|
||||||
|
# Compute the next step within a distance limit of 3 units
|
||||||
|
next_step = step_from_to_3d(node0, node1, limit=3)
|
||||||
|
|
||||||
|
# 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
|
||||||
|
|
||||||
|
|
||||||
## Website
|
## Website
|
||||||
- https://pypi.org/project/bellande_robot_step/
|
- https://pypi.org/project/bellande_robot_step/
|
||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
- clone this repo
|
|
||||||
- `$ pip install bellande_robot_step`
|
- `$ pip install bellande_robot_step`
|
||||||
- `$ pip show -f bellande_robot_step`
|
|
||||||
|
|
||||||
```
|
```
|
||||||
Name: bellande_robot_step
|
Name: bellande_robot_step
|
||||||
|
Reference in New Issue
Block a user