Skip to content

Commit c34fd5d

Browse files
committed
fix(README): Added a description of the usage and checks that can be performed using the inspector lib.
1 parent 6074cba commit c34fd5d

File tree

1 file changed

+44
-2
lines changed

1 file changed

+44
-2
lines changed

README.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,50 @@ Go check out the online documentation at [docs.geode-solutions.com].
4343
Installing OpenGeode-Inspector is done:
4444

4545
* either by compiling the C++ source.
46-
* or by using the pip command ```pip install opengeode-inspector``` and adding ```import opengeode_inspector``` in your Python script. Check [this documentation page](https://docs.geode-solutions.com/how-to-use-binding) for more details. Examples are also procured in the ```examples``` folder.
47-
46+
* or by installing the python library using the pip command ```pip install opengeode-inspector```.
47+
48+
## Usage
49+
50+
To use OpenGeode-Inspector, several options are available:
51+
52+
* 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.
53+
* 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.
54+
* 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/how-to-use-binding) for more details. Examples are also procured in the ```examples``` folder.
55+
* You can inspect your models without any installation, by using the API of the [Geode-solutions free tools](https://geode-solutions.com/tools).
56+
57+
The available checks for each mesh type are:
58+
* PointSet:
59+
* Colocation of vertices
60+
* EdgedCurve:
61+
* Colocation of vertices
62+
* Degeneration of edges
63+
* SurfaceMesh:
64+
* Adjacency of polygons
65+
* Colocation of vertices
66+
* Degeneration of edges
67+
* Degeneration of polygons
68+
* Intersection of triangles (for triangulated surfaces)
69+
* Manifold of vertices
70+
* Manifold of edges
71+
* SolidMesh:
72+
* Adjacency of polyhedra
73+
* Colocation of vertices
74+
* Degeneration of edges
75+
* Degeneration of polyhedra
76+
* Manifold of vertices
77+
* Manifold of edges
78+
* Manifold of facets
79+
The available checks for each model type are:
80+
* Section:
81+
* Validity of the topology
82+
* Checks on each component mesh: all the previous mesh checks depending on the component mesh type
83+
* Checks on the validity of the unique vertices (linking to vertices, colocation of unique vertices points, un-colocation of points with same unique vertices)
84+
* Intersection of the component mesh surfaces between each other
85+
* BRep:
86+
* Validity of the topology
87+
* Checks on each component mesh: all the previous mesh checks depending on the component mesh type
88+
* Checks on the validity of the unique vertices (linking to vertices, colocation of unique vertices points, un-colocation of points with same unique vertices)
89+
* Intersection of the component mesh surfaces between each other
4890

4991
## Questions
5092
For questions and support please use the official [slack](https://slackin-opengeode.herokuapp.com) and go to the channel #inspector. The issue list of this repo is exclusively for bug reports and feature requests.

0 commit comments

Comments
 (0)