bellande-robot-step


Namebellande-robot-step JSON
Version 0.3.0 PyPI version JSON
download
home_page
SummaryRobots Step
upload_time2024-01-30 19:06:22
maintainer
docs_urlNone
authorRonaldsonBellande
requires_python>=3.0
license
keywords package setuptools
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 📦 Bellande Step

### ✔️ confirmed versions
- `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 Import 
from bellande_robot_step.bellande_robot_step_2d import bellande_step_2d, Node2D

# Define the nodes
node0 = Node2D(0, 0)
node1 = Node2D(5, 5)

# Compute the next step within a distance limit of 3 units
next_step = bellande_step_2d(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 Import 
from bellande_robot_step.bellande_robot_step_2d import bellande_step_2d, Node2D 

# Define the nodes
node0 = Node3D(0, 0, 0)
node1 = Node3D(5, 5, 5)

# Compute the next step within a distance limit of 3 units
next_step = bellande_step_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
- https://pypi.org/project/bellande_robot_step/

### Installation
- `$ pip install bellande_robot_step`

### Upgrade (if not upgraded)
- `$ pip install --upgrade bellande_robot_step`

```
Name: bellande_robot_step
Version: 0.3.0
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:
```

### License
This Package is distributed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), see [LICENSE](https://github.com/RonaldsonBellande/bellande_robot_step/blob/main/LICENSE) and [NOTICE](https://github.com/RonaldsonBellande/bellande_robot_step/blob/main/LICENSE) for more information.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "bellande-robot-step",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.0",
    "maintainer_email": "",
    "keywords": "package,setuptools",
    "author": "RonaldsonBellande",
    "author_email": "ronaldsonbellande@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/b3/ab/64d81cb89c70e4f54b133c79f7f995ab783ba63ddc86acfe431ec749852d/bellande_robot_step-0.3.0.tar.gz",
    "platform": null,
    "description": "# \ud83d\udce6 Bellande Step\n\n### \u2714\ufe0f confirmed versions\n- `The step function efficiently computes the next step towards a target node within a specified distance limit.`\n\n## Usage 2D Space\n\nSuppose you have two nodes representing positions in a 2D space:\n- `node0` at coordinates `(0, 0)`\n- `node1` at coordinates `(5, 5)`\n\nYou want to compute the next step from `node0` towards `node1` while limiting the maximum distance to 3 units.\n\n```python\n# Define Import \nfrom bellande_robot_step.bellande_robot_step_2d import bellande_step_2d, Node2D\n\n# Define the nodes\nnode0 = Node2D(0, 0)\nnode1 = Node2D(5, 5)\n\n# Compute the next step within a distance limit of 3 units\nnext_step = bellande_step_2d(node0, node1, limit=3)\n\n# Output the coordinates of the next step\nprint(\"Next Step Coordinates:\", next_step.coord) \n```\n\n## Usage 3D Space\n\nSuppose you have two nodes representing positions in a 3D space:\n- `node0` at coordinates `(0, 0, 0)`\n- `node1` at coordinates `(5, 5, 5)`\n\nYou want to compute the next step from `node0` towards `node1` while limiting the maximum distance to 3 units.\n\n```python\n# Define Import \nfrom bellande_robot_step.bellande_robot_step_2d import bellande_step_2d, Node2D \n\n# Define the nodes\nnode0 = Node3D(0, 0, 0)\nnode1 = Node3D(5, 5, 5)\n\n# Compute the next step within a distance limit of 3 units\nnext_step = bellande_step_3d(node0, node1, limit=3)\n\n# Output the coordinates of the next step\nprint(\"Next Step Coordinates:\", next_step.coord)\n```\n\n### Avaliable\n- 2D Space\n- 3D Space\n- 4D Space\n- 5D Space\n- 6D Space\n- 7D Space\n- 8D Space\n- 9D Space\n- 10D Space\n\n\n## Website\n- https://pypi.org/project/bellande_robot_step/\n\n### Installation\n- `$ pip install bellande_robot_step`\n\n### Upgrade (if not upgraded)\n- `$ pip install --upgrade bellande_robot_step`\n\n```\nName: bellande_robot_step\nVersion: 0.3.0\nSummary: Computes the next step towards a target node\nHome-page: github.com/RonaldsonBellande/bellande_robot_step\nAuthor: Ronaldson Bellande\nAuthor-email: ronaldsonbellande@gmail.com\nLicense: GNU General Public License v3.0\nRequires: numpy\nRequired-by:\n```\n\n### License\nThis Package is distributed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), see [LICENSE](https://github.com/RonaldsonBellande/bellande_robot_step/blob/main/LICENSE) and [NOTICE](https://github.com/RonaldsonBellande/bellande_robot_step/blob/main/LICENSE) for more information.\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Robots Step",
    "version": "0.3.0",
    "project_urls": {
        "Home": "https://github.com/RonaldsonBellande/bellande_robot_step",
        "Homepage": "https://github.com/RonaldsonBellande/bellande_robot_step",
        "documentation": "https://github.com/RonaldsonBellande/bellande_robot_step",
        "repository": "https://github.com/RonaldsonBellande/bellande_robot_step"
    },
    "split_keywords": [
        "package",
        "setuptools"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b3ab64d81cb89c70e4f54b133c79f7f995ab783ba63ddc86acfe431ec749852d",
                "md5": "05210be6a026f0da5ea9918910f588ac",
                "sha256": "c6840844596e6e7db230182aa7e6dc18b0ff7f9df9d70ed5926129e676088ab2"
            },
            "downloads": -1,
            "filename": "bellande_robot_step-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "05210be6a026f0da5ea9918910f588ac",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.0",
            "size": 17180,
            "upload_time": "2024-01-30T19:06:22",
            "upload_time_iso_8601": "2024-01-30T19:06:22.753994Z",
            "url": "https://files.pythonhosted.org/packages/b3/ab/64d81cb89c70e4f54b133c79f7f995ab783ba63ddc86acfe431ec749852d/bellande_robot_step-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-30 19:06:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "RonaldsonBellande",
    "github_project": "bellande_robot_step",
    "github_not_found": true,
    "lcname": "bellande-robot-step"
}
        
Elapsed time: 0.24084s