# 📦 Bellande Particle
## 🧙 Organization Website
- [](https://robotics-sensors.github.io)
## 🧙 Organization Github
- [](https://github.com/Robotics-Sensors)
# Author, Creator and Maintainer
- **Ronaldson Bellande**
# API HTTP Usability (BELLANDE FORMAT)
```
# Copyright (C) 2024 Bellande Robotics Sensors Research Innovation Center, Ronaldson Bellande
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
# GNU General Public License v3.0 or later
url: https://bellande-robotics-sensors-research-innovation-center.org
endpoint_paths:
move: /api/Bellande_Particle/move
read_markers: /api/Bellande_Particle/read_markers
create_random: /api/Bellande_Particle/create_random
Bellande_Framework_Access_Key: bellande_web_api_opensource
```
# API HTTP Usability (JSON FORMAT)
```json
{
"license": [
"Copyright (C) 2024 Bellande Robotics Sensors Research Innovation Center, Ronaldson Bellande",
"This program is free software: you can redistribute it and/or modify",
"it under the terms of the GNU General Public License as published by",
"the Free Software Foundation, either version 3 of the License, or",
"(at your option) any later version.",
"",
"This program is distributed in the hope that it will be useful,",
"but WITHOUT ANY WARRANTY; without even the implied warranty of",
"MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the",
"GNU General Public License for more details.",
"",
"You should have received a copy of the GNU General Public License",
"along with this program. If not, see <https://www.gnu.org/licenses/>.",
"GNU General Public License v3.0 or later"
],
"url": "https://bellande-robotics-sensors-research-innovation-center.org",
"endpoint_paths": {
"move": "/api/Bellande_Particle/move",
"read_markers": "/api/Bellande_Particle/read_markers",
"create_random": "/api/Bellande_Particle/create_random"
},
"Bellande_Framework_Access_Key": "bellande_web_api_opensource"
}
```
# API Payload Examples
## Move Particle
```json
{
"particle": {
"x": 0,
"y": 0,
"heading": 0,
"weight": 1.0
},
"rotation1": 45.0,
"translation": 1.0,
"rotation2": -45.0,
"auth": {
"authorization_key": "bellande_web_api_opensource"
}
}
```
## Read Markers
```json
{
"particle": {
"x": 0,
"y": 0,
"heading": 0,
"weight": 1.0
},
"world": {
"width": 10.0,
"height": 10.0,
"markers": [[1.0, 1.0]]
},
"auth": {
"authorization_key": "bellande_web_api_opensource"
}
}
```
## Create Random
```json
{
"count": 10,
"world": {
"width": 10.0,
"height": 10.0,
"markers": [[1.0, 1.0]]
},
"auth": {
"authorization_key": "bellande_web_api_opensource"
}
}
```
# 🧙 Website Bellande API Testing
- [](https://bellande-robotics-sensors-research-innovation-center.org/api/bellande_particle_experiment)
# Quick Bellande API Testing Examples
## Move Particle
```bash
curl -X 'POST' \
'https://bellande-robotics-sensors-research-innovation-center.org/api/Bellande_Particle/move' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"particle": {
"x": 0,
"y": 0,
"heading": 0,
"weight": 1.0
},
"rotation1": 45.0,
"translation": 1.0,
"rotation2": -45.0,
"auth": {
"authorization_key": "bellande_web_api_opensource"
}
}'
```
## Read Markers
```bash
curl -X 'POST' \
'https://bellande-robotics-sensors-research-innovation-center.org/api/Bellande_Particle/read_markers' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"particle": {
"x": 0,
"y": 0,
"heading": 0,
"weight": 1.0
},
"world": {
"width": 10.0,
"height": 10.0,
"markers": [[1.0, 1.0]]
},
"auth": {
"authorization_key": "bellande_web_api_opensource"
}
}'
```
## Create Random
```bash
curl -X 'POST' \
'https://bellande-robotics-sensors-research-innovation-center.org/api/Bellande_Particle/create_random' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"count": 10,
"world": {
"width": 10.0,
"height": 10.0,
"markers": [[1.0, 1.0]]
},
"auth": {
"authorization_key": "bellande_web_api_opensource"
}
}'
```
# Bellande Particle Usage
## Website Crates
- https://crates.io/crates/bellande_particle
### Installation
- `cargo add bellande_particle`
## Website PYPI
- https://pypi.org/project/bellande_particle
### Installation
- `$ pip install bellande_particle`
### Command Line Usage Examples
```bash
# Move particle
bellande_particle move \
--particle-state "[0,0,0,1.0]" \
--rotation1 45.0 \
--translation 1.0 \
--rotation2 -45.0
# Read markers
bellande_particle read-markers \
--particle-state "[0,0,0,1.0]" \
--world '{"width":10.0,"height":10.0,"markers":[[1.0,1.0]]}'
# Create random particles
bellande_particle create-random \
--count 10 \
--world '{"width":10.0,"height":10.0,"markers":[[1.0,1.0]]}'
```
### Upgrade
- `$ pip install --upgrade bellande_particle`
```
Name: bellande_particle
Summary: A particle system using Bellande distributions for robust state estimation and localization
Home-page: github.com/Robotics-Sensors/bellande_particle
Author: Ronaldson Bellande
Author-email: ronaldsonbellande@gmail.com
License: GNU General Public License v3.0
```
## 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/Robotics-Sensors/bellande_particle/blob/main/LICENSE) and [NOTICE](https://github.com/Robotics-Sensors/bellande_particle/blob/main/LICENSE) for more information.
Raw data
{
"_id": null,
"home_page": null,
"name": "bellande-particle",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.0",
"maintainer_email": null,
"keywords": "package, setuptools",
"author": "RonaldsonBellande",
"author_email": "ronaldsonbellande@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/6e/00/d22006989e36e33e52790b9cca287e703a9724fefc32e5b783c425d1b85e/bellande_particle-0.0.2.tar.gz",
"platform": null,
"description": "# \ud83d\udce6 Bellande Particle\n\n## \ud83e\uddd9 Organization Website\n- [](https://robotics-sensors.github.io)\n\n## \ud83e\uddd9 Organization Github\n- [](https://github.com/Robotics-Sensors)\n\n# Author, Creator and Maintainer\n- **Ronaldson Bellande**\n\n# API HTTP Usability (BELLANDE FORMAT)\n```\n# Copyright (C) 2024 Bellande Robotics Sensors Research Innovation Center, Ronaldson Bellande\n# This program is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n# \n# This program is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n\n# You should have received a copy of the GNU General Public License\n# along with this program. If not, see <https://www.gnu.org/licenses/>.\n# GNU General Public License v3.0 or later\n\nurl: https://bellande-robotics-sensors-research-innovation-center.org\n\nendpoint_paths:\n move: /api/Bellande_Particle/move\n read_markers: /api/Bellande_Particle/read_markers\n create_random: /api/Bellande_Particle/create_random\n\nBellande_Framework_Access_Key: bellande_web_api_opensource\n```\n\n# API HTTP Usability (JSON FORMAT)\n```json\n{\n \"license\": [\n \"Copyright (C) 2024 Bellande Robotics Sensors Research Innovation Center, Ronaldson Bellande\",\n \"This program is free software: you can redistribute it and/or modify\",\n \"it under the terms of the GNU General Public License as published by\",\n \"the Free Software Foundation, either version 3 of the License, or\",\n \"(at your option) any later version.\",\n \"\",\n \"This program is distributed in the hope that it will be useful,\",\n \"but WITHOUT ANY WARRANTY; without even the implied warranty of\",\n \"MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\",\n \"GNU General Public License for more details.\",\n \"\",\n \"You should have received a copy of the GNU General Public License\",\n \"along with this program. If not, see <https://www.gnu.org/licenses/>.\",\n \"GNU General Public License v3.0 or later\"\n ],\n \"url\": \"https://bellande-robotics-sensors-research-innovation-center.org\",\n \"endpoint_paths\": {\n \"move\": \"/api/Bellande_Particle/move\",\n \"read_markers\": \"/api/Bellande_Particle/read_markers\",\n \"create_random\": \"/api/Bellande_Particle/create_random\"\n },\n \"Bellande_Framework_Access_Key\": \"bellande_web_api_opensource\"\n}\n```\n\n# API Payload Examples\n\n## Move Particle\n```json\n{\n \"particle\": {\n \"x\": 0,\n \"y\": 0,\n \"heading\": 0,\n \"weight\": 1.0\n },\n \"rotation1\": 45.0,\n \"translation\": 1.0,\n \"rotation2\": -45.0,\n \"auth\": {\n \"authorization_key\": \"bellande_web_api_opensource\"\n }\n}\n```\n\n## Read Markers\n```json\n{\n \"particle\": {\n \"x\": 0,\n \"y\": 0,\n \"heading\": 0,\n \"weight\": 1.0\n },\n \"world\": {\n \"width\": 10.0,\n \"height\": 10.0,\n \"markers\": [[1.0, 1.0]]\n },\n \"auth\": {\n \"authorization_key\": \"bellande_web_api_opensource\"\n }\n}\n```\n\n## Create Random\n```json\n{\n \"count\": 10,\n \"world\": {\n \"width\": 10.0,\n \"height\": 10.0,\n \"markers\": [[1.0, 1.0]]\n },\n \"auth\": {\n \"authorization_key\": \"bellande_web_api_opensource\"\n }\n}\n```\n\n# \ud83e\uddd9 Website Bellande API Testing \n- [](https://bellande-robotics-sensors-research-innovation-center.org/api/bellande_particle_experiment)\n \n# Quick Bellande API Testing Examples\n\n## Move Particle\n```bash\ncurl -X 'POST' \\\n 'https://bellande-robotics-sensors-research-innovation-center.org/api/Bellande_Particle/move' \\\n -H 'accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"particle\": {\n \"x\": 0,\n \"y\": 0,\n \"heading\": 0,\n \"weight\": 1.0\n },\n \"rotation1\": 45.0,\n \"translation\": 1.0,\n \"rotation2\": -45.0,\n \"auth\": {\n \"authorization_key\": \"bellande_web_api_opensource\"\n }\n }'\n```\n\n## Read Markers\n```bash\ncurl -X 'POST' \\\n 'https://bellande-robotics-sensors-research-innovation-center.org/api/Bellande_Particle/read_markers' \\\n -H 'accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"particle\": {\n \"x\": 0,\n \"y\": 0,\n \"heading\": 0,\n \"weight\": 1.0\n },\n \"world\": {\n \"width\": 10.0,\n \"height\": 10.0,\n \"markers\": [[1.0, 1.0]]\n },\n \"auth\": {\n \"authorization_key\": \"bellande_web_api_opensource\"\n }\n }'\n```\n\n## Create Random\n```bash\ncurl -X 'POST' \\\n 'https://bellande-robotics-sensors-research-innovation-center.org/api/Bellande_Particle/create_random' \\\n -H 'accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"count\": 10,\n \"world\": {\n \"width\": 10.0,\n \"height\": 10.0,\n \"markers\": [[1.0, 1.0]]\n },\n \"auth\": {\n \"authorization_key\": \"bellande_web_api_opensource\"\n }\n }'\n```\n\n# Bellande Particle Usage\n\n## Website Crates\n- https://crates.io/crates/bellande_particle\n\n### Installation\n- `cargo add bellande_particle`\n\n## Website PYPI\n- https://pypi.org/project/bellande_particle\n\n### Installation\n- `$ pip install bellande_particle`\n\n### Command Line Usage Examples\n\n```bash\n# Move particle\nbellande_particle move \\\n --particle-state \"[0,0,0,1.0]\" \\\n --rotation1 45.0 \\\n --translation 1.0 \\\n --rotation2 -45.0\n\n# Read markers\nbellande_particle read-markers \\\n --particle-state \"[0,0,0,1.0]\" \\\n --world '{\"width\":10.0,\"height\":10.0,\"markers\":[[1.0,1.0]]}'\n\n# Create random particles\nbellande_particle create-random \\\n --count 10 \\\n --world '{\"width\":10.0,\"height\":10.0,\"markers\":[[1.0,1.0]]}'\n```\n\n### Upgrade\n- `$ pip install --upgrade bellande_particle`\n\n```\nName: bellande_particle\nSummary: A particle system using Bellande distributions for robust state estimation and localization\nHome-page: github.com/Robotics-Sensors/bellande_particle\nAuthor: Ronaldson Bellande\nAuthor-email: ronaldsonbellande@gmail.com\nLicense: GNU General Public License v3.0\n```\n\n## License\nThis 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/Robotics-Sensors/bellande_particle/blob/main/LICENSE) and [NOTICE](https://github.com/Robotics-Sensors/bellande_particle/blob/main/LICENSE) for more information.\n",
"bugtrack_url": null,
"license": null,
"summary": "Robotics Particle",
"version": "0.0.2",
"project_urls": {
"Home": "https://github.com/Robotics-Sensors/bellande_particle",
"Homepage": "https://github.com/Robotics-Sensors/bellande_particle",
"documentation": "https://github.com/Robotics-Sensors/bellande_particle",
"repository": "https://github.com/Robotics-Sensors/bellande_particle"
},
"split_keywords": [
"package",
" setuptools"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6e00d22006989e36e33e52790b9cca287e703a9724fefc32e5b783c425d1b85e",
"md5": "9ccb071ff7827ae6579ec2343f9ea0f7",
"sha256": "2b4f0bd67c771041327d5646bb1127c941076684c7787713b72c24a538d72813"
},
"downloads": -1,
"filename": "bellande_particle-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "9ccb071ff7827ae6579ec2343f9ea0f7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.0",
"size": 5854,
"upload_time": "2024-12-18T15:09:13",
"upload_time_iso_8601": "2024-12-18T15:09:13.740442Z",
"url": "https://files.pythonhosted.org/packages/6e/00/d22006989e36e33e52790b9cca287e703a9724fefc32e5b783c425d1b85e/bellande_particle-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-18 15:09:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Robotics-Sensors",
"github_project": "bellande_particle",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "bellande-particle"
}
JSON
