diff --git a/README.md b/README.md index 329d862..5fe2c5f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # 📦 Bellande Step (Infinite Dimensions) +![Demo GIF](bellande_step_api_package.gif) + ## Preprint - [![Preprint](https://img.shields.io/badge/Preprint-Bellande%20Step-0099cc?style=for-the-badge)](https://dapp.orvium.io/deposits/6650ccb8afb407dc8beb0ff2/view) @@ -146,8 +148,13 @@ curl -X 'POST' \ - https://robotics-sensors.github.io - Check out website for more information avaliable open-source API +# API via Executable +- Infinite Space + +``` +bellande_step "[0, 0, 0]" "[100, 100, 100]" 75 3 +``` # API in api_docs -- Temporarily Enabled for OpenSource - 2D Space - 3D Space - 4D Space @@ -173,7 +180,7 @@ You want to compute the next step from `node0` towards `node1` while limiting th ```python # Define Import -from bellande_robot_step.bellande_robot_step_2d import bellande_step_2d, Node2D +from bellande_step.bellande_step_2d import bellande_step_2d, Node2D # Define the nodes node0 = Node2D(0, 0) @@ -196,7 +203,7 @@ You want to compute the next step from `node0` towards `node1` while limiting th ```python # Define Import -from bellande_robot_step.bellande_robot_step_3d import bellande_step_3d, Node3D +from bellande_step.bellande_step_3d import bellande_step_3d, Node3D # Define the nodes node0 = Node3D(0, 0, 0) diff --git a/bellande_step_api_package.gif b/bellande_step_api_package.gif new file mode 100644 index 0000000..9b29d75 Binary files /dev/null and b/bellande_step_api_package.gif differ diff --git a/run_api.sh b/run_api.sh new file mode 100755 index 0000000..62ea96e --- /dev/null +++ b/run_api.sh @@ -0,0 +1,15 @@ +curl -X 'POST' \ + 'https://bellande-robotics-sensors-research-innovation-center.org/api/Bellande_Step/bellande_step_nd' \ + -H 'accept: application/json' \ + -H 'Content-Type: application/json' \ + -d '{ + "node0": [0, 0, 0], + "node1": [100, 100, 100], + "limit": 75, + "dimensions": 3, + "auth": { + "authorization_key": "bellande_web_api_opensource" + } + }' + +echo "" diff --git a/src/bellande_step/bellande_step.py b/src/bellande_step/bellande_step.py index 2f428fa..86253d7 100644 --- a/src/bellande_step/bellande_step.py +++ b/src/bellande_step/bellande_step.py @@ -1,3 +1,20 @@ +# 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 . + +#!/usr/bin/env python3 + import subprocess import argparse import json diff --git a/src/bellande_step/bellande_step_10d.py b/src/bellande_step/bellande_step_10d.py index c9ffda1..78b674b 100644 --- a/src/bellande_step/bellande_step_10d.py +++ b/src/bellande_step/bellande_step_10d.py @@ -1,3 +1,18 @@ +# 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 . + #!/usr/bin/env python3 from header_imports import * diff --git a/src/bellande_step/bellande_step_2d.py b/src/bellande_step/bellande_step_2d.py index 2a40cc5..551eaf5 100644 --- a/src/bellande_step/bellande_step_2d.py +++ b/src/bellande_step/bellande_step_2d.py @@ -1,3 +1,18 @@ +# 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 . + #!/usr/bin/env python3 from header_imports import * diff --git a/src/bellande_step/bellande_step_3d.py b/src/bellande_step/bellande_step_3d.py index 859dd30..0b47900 100644 --- a/src/bellande_step/bellande_step_3d.py +++ b/src/bellande_step/bellande_step_3d.py @@ -1,3 +1,18 @@ +# 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 . + #!/usr/bin/env python3 from header_imports import * diff --git a/src/bellande_step/bellande_step_4d.py b/src/bellande_step/bellande_step_4d.py index cee48b9..f56a493 100644 --- a/src/bellande_step/bellande_step_4d.py +++ b/src/bellande_step/bellande_step_4d.py @@ -1,3 +1,18 @@ +# 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 . + #!/usr/bin/env python3 from header_imports import * diff --git a/src/bellande_step/bellande_step_5d.py b/src/bellande_step/bellande_step_5d.py index f59f92a..30e62e6 100644 --- a/src/bellande_step/bellande_step_5d.py +++ b/src/bellande_step/bellande_step_5d.py @@ -1,3 +1,18 @@ +# 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 . + #!/usr/bin/env python3 from header_imports import * diff --git a/src/bellande_step/bellande_step_6d.py b/src/bellande_step/bellande_step_6d.py index 5c5f3fe..56d7a1e 100644 --- a/src/bellande_step/bellande_step_6d.py +++ b/src/bellande_step/bellande_step_6d.py @@ -1,3 +1,18 @@ +# 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 . + #!/usr/bin/env python3 from header_imports import * diff --git a/src/bellande_step/bellande_step_7d.py b/src/bellande_step/bellande_step_7d.py index 52262d3..6ee60d2 100644 --- a/src/bellande_step/bellande_step_7d.py +++ b/src/bellande_step/bellande_step_7d.py @@ -1,3 +1,18 @@ +# 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 . + #!/usr/bin/env python3 from header_imports import * diff --git a/src/bellande_step/bellande_step_8d.py b/src/bellande_step/bellande_step_8d.py index d09065c..418f6d6 100644 --- a/src/bellande_step/bellande_step_8d.py +++ b/src/bellande_step/bellande_step_8d.py @@ -1,3 +1,18 @@ +# 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 . + #!/usr/bin/env python3 from header_imports import * diff --git a/src/bellande_step/bellande_step_9d.py b/src/bellande_step/bellande_step_9d.py index 43fbbe6..1433a9e 100644 --- a/src/bellande_step/bellande_step_9d.py +++ b/src/bellande_step/bellande_step_9d.py @@ -1,3 +1,18 @@ +# 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 . + #!/usr/bin/env python3 from header_imports import *