<h1 align="center">octomap_py</h1>
<h4 align="center">Python binding of <a href="https://github.com/OctoMap/octomap">the OctoMap library</a>.</h4>
<div align="center">
<a href="https://pypi.python.org/pypi/octomap-py"><img src="https://img.shields.io/pypi/v/octomap-py.svg"></a>
<a href="https://pypi.org/project/octomap-py"><img src="https://img.shields.io/pypi/pyversions/octomap-py.svg"></a>
</div>
## Installation
### From PyPI
Install `octomap-py` directly from PyPI:
```bash
pip install octomap-py
```
**Prerequisites:**
* Python development headers: `sudo apt-get install python3-dev`
* C++ compiler: `sudo apt-get install build-essential`
* CMake: `sudo apt-get install cmake`
### From Source
Alternatively, clone the repository and install:
```
git clone https://github.com/ethanmclark1/octomap_py.git
cd octomap_py
pip install -e '.[example]'
```
## Example Usage
Clone the repository, navigate to examples, and run:
```
cd examples
python insertPointCloud.py
```
<img src="examples/.readme/insertPointCloud.jpg" height="200px" />
## Quick API Overview
```
import octomap
# Create an empty OctoMap
octree = octomap.OcTree(0.1)
# Insert a point cloud
point_cloud = octomap.Pointcloud()
point_cloud.push_back(1.0, 0.0, 0.0)
octree.insertPointCloud(point_cloud, octomap.point3d(0.0, 0.0, 0.0))
# Save and load the map
octree.writeBinary("example_map.bt")
octree.readBinary("example_map.bt")
```
## Acknowledgement
This is a fork of [wkentaro/octoma-python](https://github.com/wkentaro/octomap_py) which is a fork of [neka-nat/python-octomap](https://github.com/neka-nat/python-octomap).
## License
`octomap-py` is licensed under the BSD License. See the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/ethanmclark1/octomap_py",
"name": "octomap-py",
"maintainer": "Blake Narramore, Ethan Clark",
"docs_url": null,
"requires_python": null,
"maintainer_email": "blaque2pi@msn.com, eclark715@gmail.com",
"keywords": null,
"author": "Blake Narramore",
"author_email": "blaque2pi@msn.com",
"download_url": "https://files.pythonhosted.org/packages/10/93/cdc055a5017bfe7b153401db59bfce622c5a5fae6e16ff7558e1a3c4ebf9/octomap_py-1.8.0.post15.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">octomap_py</h1>\n<h4 align=\"center\">Python binding of <a href=\"https://github.com/OctoMap/octomap\">the OctoMap library</a>.</h4>\n\n<div align=\"center\">\n <a href=\"https://pypi.python.org/pypi/octomap-py\"><img src=\"https://img.shields.io/pypi/v/octomap-py.svg\"></a>\n <a href=\"https://pypi.org/project/octomap-py\"><img src=\"https://img.shields.io/pypi/pyversions/octomap-py.svg\"></a>\n</div>\n\n## Installation\n\n### From PyPI\n\nInstall `octomap-py` directly from PyPI:\n\n```bash\npip install octomap-py\n```\n\n**Prerequisites:**\n\n* Python development headers: `sudo apt-get install python3-dev`\n* C++ compiler: `sudo apt-get install build-essential`\n* CMake: `sudo apt-get install cmake`\n\n### From Source\n\nAlternatively, clone the repository and install:\n\n```\ngit clone https://github.com/ethanmclark1/octomap_py.git\ncd octomap_py\npip install -e '.[example]'\n```\n\n## Example Usage\n\nClone the repository, navigate to examples, and run:\n\n```\ncd examples\npython insertPointCloud.py\n\n```\n\n<img src=\"examples/.readme/insertPointCloud.jpg\" height=\"200px\" />\n\n## Quick API Overview\n\n```\nimport octomap\n\n# Create an empty OctoMap\noctree = octomap.OcTree(0.1)\n\n# Insert a point cloud\npoint_cloud = octomap.Pointcloud()\npoint_cloud.push_back(1.0, 0.0, 0.0)\noctree.insertPointCloud(point_cloud, octomap.point3d(0.0, 0.0, 0.0))\n\n# Save and load the map\noctree.writeBinary(\"example_map.bt\")\noctree.readBinary(\"example_map.bt\")\n```\n\n## Acknowledgement\n\nThis is a fork of [wkentaro/octoma-python](https://github.com/wkentaro/octomap_py) which is a fork of [neka-nat/python-octomap](https://github.com/neka-nat/python-octomap).\n\n## License\n\n`octomap-py` is licensed under the BSD License. See the [LICENSE](LICENSE) file for details.\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "Python binding of the OctoMap library.",
"version": "1.8.0.post15",
"project_urls": {
"Homepage": "https://github.com/ethanmclark1/octomap_py"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1093cdc055a5017bfe7b153401db59bfce622c5a5fae6e16ff7558e1a3c4ebf9",
"md5": "246c508f89f1b5ca3ca820476c067b0e",
"sha256": "bc0a9719cabf5f79462b52e6e94474931d30a6e75a01e573c5ea54050dc8e79c"
},
"downloads": -1,
"filename": "octomap_py-1.8.0.post15.tar.gz",
"has_sig": false,
"md5_digest": "246c508f89f1b5ca3ca820476c067b0e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 2517467,
"upload_time": "2024-08-27T23:03:16",
"upload_time_iso_8601": "2024-08-27T23:03:16.705947Z",
"url": "https://files.pythonhosted.org/packages/10/93/cdc055a5017bfe7b153401db59bfce622c5a5fae6e16ff7558e1a3c4ebf9/octomap_py-1.8.0.post15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-27 23:03:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ethanmclark1",
"github_project": "octomap_py",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "octomap-py"
}
JSON
