<h1 align="center">OpenGeode-Inspector<sup><i>by Geode-solutions</i></sup></h1>
<h3 align="center">OpenGeode module for inspecting meshes and models</h3>
<p align="center">
<img src="https://github.com/Geode-solutions/OpenGeode-ModuleTemplate/workflows/CI/badge.svg" alt="Build Status">
<img src="https://github.com/Geode-solutions/OpenGeode-ModuleTemplate/workflows/CD/badge.svg" alt="Deploy Status">
<img src="https://codecov.io/gh/Geode-solutions/OpenGeode-ModuleTemplate/branch/master/graph/badge.svg" alt="Coverage Status">
<img src="https://img.shields.io/github/release/Geode-solutions/OpenGeode-ModuleTemplate.svg" alt="Version">
</p>
<p align="center">
<img src="https://img.shields.io/static/v1?label=Windows&logo=windows&logoColor=white&message=support&color=success" alt="Windows support">
<img src="https://img.shields.io/static/v1?label=Ubuntu&logo=Ubuntu&logoColor=white&message=support&color=success" alt="Ubuntu support">
<img src="https://img.shields.io/static/v1?label=Red%20Hat&logo=Red-Hat&logoColor=white&message=support&color=success" alt="Red Hat support">
</p>
<p align="center">
<img src="https://img.shields.io/badge/C%2B%2B-11-blue.svg" alt="Language">
<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License">
<img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="Semantic-release">
<a href="https://geode-solutions.com/#slack">
<img src="https://opengeode-slack-invite.herokuapp.com/badge.svg" alt="Slack invite">
</a>
<a href="https://doi.org/10.5281/zenodo.3610370">
<img src="https://zenodo.org/badge/DOI/10.5281/zenodo.3610370.svg" alt="DOI">
</a>
---
## Introduction
OpenGeode-Inspector is a module of [OpenGeode] providing ways of inspecting your meshes and models and verifying their validity.
[OpenGeode]: https://github.com/Geode-solutions/OpenGeode
## Documentation
Go check out the online documentation at [docs.geode-solutions.com].
[docs.geode-solutions.com] https://docs.geode-solutions.com
Installing OpenGeode-Inspector is done:
- either by compiling the C++ source.
- or by installing the python library using the pip command `pip install opengeode-inspector`.
## Usage
To use OpenGeode-Inspector, several options are available:
- If you installed and compiled the C++ source code, you can use the executable binaries to apply an inspection of your meshes/models and toggle on/off the various checks directly.
- or use the API functions (check the tests to see how it is done) if you want to go further or use the resulting errors to repair your meshes/models.
- If you installed the python library, you can add `import opengeode_inspector` in your Python script to use the available API functions. Check [this documentation page](https://docs.geode-solutions.com/guides/use-opengeode-binding.html) for more details. Examples are also procured in the `examples` folder.
- You can inspect your models without any installation, by using the API of the [Geode-solutions free tools](https://geode-solutions.com/tools).
The available checks for each mesh type are:
- PointSet:
- Colocation of vertices
- EdgedCurve:
- Colocation of vertices
- Degeneration of edges
- SurfaceMesh:
- Adjacency of polygons
- Colocation of vertices
- Degeneration of edges
- Degeneration of polygons
- Intersection of triangles (for triangulated surfaces)
- Manifold of vertices
- Manifold of edges
- SolidMesh:
- Adjacency of polyhedra
- Colocation of vertices
- Degeneration of edges
- Degeneration of polyhedra
- Manifold of vertices
- Manifold of edges
- Manifold of facets
The available checks for each model type are:
- Section:
- Validity of the topology
- Checks on each component mesh: all the previous mesh checks depending on the component mesh type
- Checks on the validity of the unique vertices (linking to vertices, colocation of unique vertices points, un-colocation of points with same unique vertices)
- Intersection of the component mesh surfaces between each other
- BRep:
- Validity of the topology
- Checks on each component mesh: all the previous mesh checks depending on the component mesh type
- Checks on the validity of the unique vertices (linking to vertices, colocation of unique vertices points, un-colocation of points with same unique vertices)
- Intersection of the component mesh surfaces between each other
## Questions
For questions and support please use the official [slack](https://opengeode-slack-invite.herokuapp.com) and go to the channel #inspector. The issue list of this repo is exclusively for bug reports and feature requests.
## License
[MIT](https://opensource.org/licenses/MIT)
Copyright (c) 2019 - 2024, Geode-solutions
Raw data
{
"_id": null,
"home_page": "https://github.com/Geode-solutions/OpenGeode-Inspector",
"name": "OpenGeode-Inspector",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Geode-solutions",
"author_email": "contact@geode-solutions.com",
"download_url": null,
"platform": null,
"description": "<h1 align=\"center\">OpenGeode-Inspector<sup><i>by Geode-solutions</i></sup></h1>\n<h3 align=\"center\">OpenGeode module for inspecting meshes and models</h3>\n\n<p align=\"center\">\n <img src=\"https://github.com/Geode-solutions/OpenGeode-ModuleTemplate/workflows/CI/badge.svg\" alt=\"Build Status\">\n <img src=\"https://github.com/Geode-solutions/OpenGeode-ModuleTemplate/workflows/CD/badge.svg\" alt=\"Deploy Status\">\n <img src=\"https://codecov.io/gh/Geode-solutions/OpenGeode-ModuleTemplate/branch/master/graph/badge.svg\" alt=\"Coverage Status\">\n <img src=\"https://img.shields.io/github/release/Geode-solutions/OpenGeode-ModuleTemplate.svg\" alt=\"Version\">\n</p>\n\n<p align=\"center\">\n <img src=\"https://img.shields.io/static/v1?label=Windows&logo=windows&logoColor=white&message=support&color=success\" alt=\"Windows support\">\n <img src=\"https://img.shields.io/static/v1?label=Ubuntu&logo=Ubuntu&logoColor=white&message=support&color=success\" alt=\"Ubuntu support\">\n <img src=\"https://img.shields.io/static/v1?label=Red%20Hat&logo=Red-Hat&logoColor=white&message=support&color=success\" alt=\"Red Hat support\">\n</p>\n\n<p align=\"center\">\n <img src=\"https://img.shields.io/badge/C%2B%2B-11-blue.svg\" alt=\"Language\">\n <img src=\"https://img.shields.io/badge/license-MIT-blue.svg\" alt=\"License\">\n <img src=\"https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\" alt=\"Semantic-release\">\n <a href=\"https://geode-solutions.com/#slack\">\n <img src=\"https://opengeode-slack-invite.herokuapp.com/badge.svg\" alt=\"Slack invite\">\n </a>\n <a href=\"https://doi.org/10.5281/zenodo.3610370\">\n <img src=\"https://zenodo.org/badge/DOI/10.5281/zenodo.3610370.svg\" alt=\"DOI\">\n </a>\n\n---\n\n## Introduction\n\nOpenGeode-Inspector is a module of [OpenGeode] providing ways of inspecting your meshes and models and verifying their validity.\n\n[OpenGeode]: https://github.com/Geode-solutions/OpenGeode\n\n## Documentation\n\nGo check out the online documentation at [docs.geode-solutions.com].\n\n[docs.geode-solutions.com] https://docs.geode-solutions.com\n\nInstalling OpenGeode-Inspector is done:\n\n- either by compiling the C++ source.\n- or by installing the python library using the pip command `pip install opengeode-inspector`.\n\n## Usage\n\nTo use OpenGeode-Inspector, several options are available:\n\n- If you installed and compiled the C++ source code, you can use the executable binaries to apply an inspection of your meshes/models and toggle on/off the various checks directly.\n- or use the API functions (check the tests to see how it is done) if you want to go further or use the resulting errors to repair your meshes/models.\n- If you installed the python library, you can add `import opengeode_inspector` in your Python script to use the available API functions. Check [this documentation page](https://docs.geode-solutions.com/guides/use-opengeode-binding.html) for more details. Examples are also procured in the `examples` folder.\n- You can inspect your models without any installation, by using the API of the [Geode-solutions free tools](https://geode-solutions.com/tools).\n\nThe available checks for each mesh type are:\n\n- PointSet:\n - Colocation of vertices\n- EdgedCurve:\n - Colocation of vertices\n - Degeneration of edges\n- SurfaceMesh:\n - Adjacency of polygons\n - Colocation of vertices\n - Degeneration of edges\n - Degeneration of polygons\n - Intersection of triangles (for triangulated surfaces)\n - Manifold of vertices\n - Manifold of edges\n- SolidMesh:\n - Adjacency of polyhedra\n - Colocation of vertices\n - Degeneration of edges\n - Degeneration of polyhedra\n - Manifold of vertices\n - Manifold of edges\n - Manifold of facets\n The available checks for each model type are:\n- Section:\n - Validity of the topology\n - Checks on each component mesh: all the previous mesh checks depending on the component mesh type\n - Checks on the validity of the unique vertices (linking to vertices, colocation of unique vertices points, un-colocation of points with same unique vertices)\n - Intersection of the component mesh surfaces between each other\n- BRep:\n - Validity of the topology\n - Checks on each component mesh: all the previous mesh checks depending on the component mesh type\n - Checks on the validity of the unique vertices (linking to vertices, colocation of unique vertices points, un-colocation of points with same unique vertices)\n - Intersection of the component mesh surfaces between each other\n\n## Questions\n\nFor questions and support please use the official [slack](https://opengeode-slack-invite.herokuapp.com) and go to the channel #inspector. The issue list of this repo is exclusively for bug reports and feature requests.\n\n## License\n\n[MIT](https://opensource.org/licenses/MIT)\n\nCopyright (c) 2019 - 2024, Geode-solutions\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Open source framework for inspecting the validity of geometric models",
"version": "5.1.3",
"project_urls": {
"Homepage": "https://github.com/Geode-solutions/OpenGeode-Inspector"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0756e4ab739bab110b808f1face0673429d3f935caddfcbadfdd045f573b40bf",
"md5": "43d78f848664d45f489ae90a4316494d",
"sha256": "5b31ad1b324f06997abe89acf6dff655f81d9f3459ca9dcfc2f3798fa77ca560"
},
"downloads": -1,
"filename": "OpenGeode_Inspector-5.1.3-cp310-cp310-manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "43d78f848664d45f489ae90a4316494d",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": null,
"size": 509257,
"upload_time": "2024-04-25T00:23:38",
"upload_time_iso_8601": "2024-04-25T00:23:38.832547Z",
"url": "https://files.pythonhosted.org/packages/07/56/e4ab739bab110b808f1face0673429d3f935caddfcbadfdd045f573b40bf/OpenGeode_Inspector-5.1.3-cp310-cp310-manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "14b1ba9b6cba3521b2e95bb977af0df6b4a6b30a3d70152156ffcd63b639367d",
"md5": "a380fcc73f39fc87e26da077ee041558",
"sha256": "8abcbc68af3e47737343a8e0a904788abe621b0ebbcded4018bda5249956bc38"
},
"downloads": -1,
"filename": "OpenGeode_Inspector-5.1.3-cp310-cp310-win_amd64.whl",
"has_sig": false,
"md5_digest": "a380fcc73f39fc87e26da077ee041558",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": null,
"size": 373272,
"upload_time": "2024-04-25T00:24:33",
"upload_time_iso_8601": "2024-04-25T00:24:33.971006Z",
"url": "https://files.pythonhosted.org/packages/14/b1/ba9b6cba3521b2e95bb977af0df6b4a6b30a3d70152156ffcd63b639367d/OpenGeode_Inspector-5.1.3-cp310-cp310-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9aba9156ff903d0342769cee35cc6c063b1215264599fa4ad43b9965cee022f9",
"md5": "b53f67cc08e2a95881e0e40deb1ff52b",
"sha256": "2e137a4c28c5fe53dbaace060c7ad0ae0baff21ff2bad8ba9ed0d60cb01d0489"
},
"downloads": -1,
"filename": "OpenGeode_Inspector-5.1.3-cp311-cp311-manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "b53f67cc08e2a95881e0e40deb1ff52b",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": null,
"size": 509201,
"upload_time": "2024-04-25T00:23:35",
"upload_time_iso_8601": "2024-04-25T00:23:35.516641Z",
"url": "https://files.pythonhosted.org/packages/9a/ba/9156ff903d0342769cee35cc6c063b1215264599fa4ad43b9965cee022f9/OpenGeode_Inspector-5.1.3-cp311-cp311-manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a33c4ff9f6733d9057da2b3f341a30a17600a29b3b6a28d340ab0e97e3f38c48",
"md5": "00641a0f62f15feac690ca357a121048",
"sha256": "f3223c79ac341c4def55993383f47d3cb30f36d87c92378f58bddd4efa8296a8"
},
"downloads": -1,
"filename": "OpenGeode_Inspector-5.1.3-cp311-cp311-win_amd64.whl",
"has_sig": false,
"md5_digest": "00641a0f62f15feac690ca357a121048",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": null,
"size": 373280,
"upload_time": "2024-04-25T00:24:45",
"upload_time_iso_8601": "2024-04-25T00:24:45.818479Z",
"url": "https://files.pythonhosted.org/packages/a3/3c/4ff9f6733d9057da2b3f341a30a17600a29b3b6a28d340ab0e97e3f38c48/OpenGeode_Inspector-5.1.3-cp311-cp311-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ceb1bf82e5a876426c2b8ff1b3cd5649b78f321f9275d39b0934ab1fc5ebb6cb",
"md5": "932d0a35ca7b5b7afaad114f2ff1e140",
"sha256": "edf8d3c1c48932d8a97be869d1a0c3e64938c24901501cd4ca3fc3416b3eb12c"
},
"downloads": -1,
"filename": "OpenGeode_Inspector-5.1.3-cp38-cp38-manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "932d0a35ca7b5b7afaad114f2ff1e140",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": null,
"size": 508994,
"upload_time": "2024-04-25T00:23:23",
"upload_time_iso_8601": "2024-04-25T00:23:23.358674Z",
"url": "https://files.pythonhosted.org/packages/ce/b1/bf82e5a876426c2b8ff1b3cd5649b78f321f9275d39b0934ab1fc5ebb6cb/OpenGeode_Inspector-5.1.3-cp38-cp38-manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6b47d23a27c7d48938a652a19c35c72c377890b9be92e5f98ed3f40be2bbcbf9",
"md5": "8b7f9f000faa89225f4b0a77b0189c33",
"sha256": "5f9e5f77b4902d11f99ece67a611b7284e334f1b8f8972f2895146ba485ea85a"
},
"downloads": -1,
"filename": "OpenGeode_Inspector-5.1.3-cp38-cp38-win_amd64.whl",
"has_sig": false,
"md5_digest": "8b7f9f000faa89225f4b0a77b0189c33",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": null,
"size": 373372,
"upload_time": "2024-04-25T00:24:35",
"upload_time_iso_8601": "2024-04-25T00:24:35.217900Z",
"url": "https://files.pythonhosted.org/packages/6b/47/d23a27c7d48938a652a19c35c72c377890b9be92e5f98ed3f40be2bbcbf9/OpenGeode_Inspector-5.1.3-cp38-cp38-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6d65029bcec2b4f5e6da25921de204a24ee3b5c7be64d6a2090d2b39cb6b9e6a",
"md5": "6994c181c846d4b3bdb0963b733ce629",
"sha256": "b6a89e8704074f28ba57e606cc3eaa99a5f956e6c239a17c42b061223af4aff7"
},
"downloads": -1,
"filename": "OpenGeode_Inspector-5.1.3-cp39-cp39-manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "6994c181c846d4b3bdb0963b733ce629",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": null,
"size": 509164,
"upload_time": "2024-04-25T00:23:26",
"upload_time_iso_8601": "2024-04-25T00:23:26.314007Z",
"url": "https://files.pythonhosted.org/packages/6d/65/029bcec2b4f5e6da25921de204a24ee3b5c7be64d6a2090d2b39cb6b9e6a/OpenGeode_Inspector-5.1.3-cp39-cp39-manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "31d15b2f5478b6f3aa33d992b2481f22739db83f89082238c007a63038b7ed06",
"md5": "0cee1b44e514f84acc0cfdeaafe9edcb",
"sha256": "69091445bbc59ac23c1dc615ec633ce706a6c3fc1c1521e9fb259e5f463c81ee"
},
"downloads": -1,
"filename": "OpenGeode_Inspector-5.1.3-cp39-cp39-win_amd64.whl",
"has_sig": false,
"md5_digest": "0cee1b44e514f84acc0cfdeaafe9edcb",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": null,
"size": 352446,
"upload_time": "2024-04-25T00:25:36",
"upload_time_iso_8601": "2024-04-25T00:25:36.651825Z",
"url": "https://files.pythonhosted.org/packages/31/d1/5b2f5478b6f3aa33d992b2481f22739db83f89082238c007a63038b7ed06/OpenGeode_Inspector-5.1.3-cp39-cp39-win_amd64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-25 00:23:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Geode-solutions",
"github_project": "OpenGeode-Inspector",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "opengeode-inspector"
}
JSON
