Skip to content

Commit

Permalink
Added Documentation.md, added tag, updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mprinkezs committed Jul 18, 2024
1 parent 88f74e4 commit c92bee9
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 4 deletions.
13 changes: 13 additions & 0 deletions AppExamples/projects/ExampleProjects/doc/Documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## ExampleProjects

Most of the App examples rely on a certain ZEISS INSPECT project file to be loaded. Some examples load the projects automatically when it is possible (E.g. in the `if __name__ == '__main__'` block) while other example require the project to be loaded manually. This is easily done using the `setup_project.py` script.

The project files are stored in this App to avoid duplication across multiple Apps.

The following project files are included:

| Project name | Description |
| --------------------------- | ------------------------------------------------------------------------- |
| zeiss_part_test_project | Simple optically measured part with a CAD, mesh and some basic inspection |
| volume_test_part | A small test volume for CT related inspections |
| zeiss_part_test_measurement | Optical measurement series and preliminary mesh of ZEISS part |
8 changes: 5 additions & 3 deletions AppExamples/projects/ExampleProjects/doc/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
## ExampleProjects

This App is part of the [ZEISS INSPECT Python API Examples](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_examples/index.html).
This App is part of the [ZEISS INSPECT Python API App Examples](https://github.com/ZEISS/zeiss-inspect-app-examples/tree/main/AppExamples).

It provides ZEISS INSPECT projects for trying the Python API examples.
See [App documentation](Documentation.md) for details.

You can [download this App](https://software-store.zeiss.com/products/apps/ExampleProjects) from the [ZEISS Quality Software Store](https://software-store.zeiss.com).
You can [download this App](https://software-store.zeiss.com/products/apps/ExampleProjects) from the [ZEISS Quality Software Store](https://software-store.zeiss.com).

The ZEISS INSPECT App develomment documentation can be found on [ZEISS IQS GitHub](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/index.html).
4 changes: 3 additions & 1 deletion AppExamples/projects/ExampleProjects/metainfo.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@
},
"software-revision": "0000",
"software-version": "ZEISS INSPECT 2025",
"tags": [],
"tags": [
"project"
],
"title": "ExampleProjects",
"uuid": "eaca1f5c-bad1-4a37-b68b-7928fe46bf8c",
"version": "1.0.0"
Expand Down

0 comments on commit c92bee9

Please sign in to comment.