Skip to content

Commit 6af7b98

Browse files
committed
ADD: new info on the readme
1 parent 9ef9c3c commit 6af7b98

File tree

3 files changed

+49
-4
lines changed

3 files changed

+49
-4
lines changed

README.md

Lines changed: 49 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,41 @@
1717

1818
# DiffCheck: CAD-Scan comparison
1919

20-
diffCheck(DF) allows to identify discrepancies across point clouds and 3D models of both individually machined timber pieces featuring various joints as well as fully assembled timber structures. It can help you quantify the differences between the CAD and scanned fabricated structure, providing a comprehensive report that highlights the discrepancies.
20+
With `diffCheck`, you can easily compare your scans and 3D models of timber structures or joinery to measure precision and see the differences at a glance, [here](https://diffcheckorg.github.io/diffCheck/quickstart.html)!
2121

22-
The software is designed to be user-friendly and can be used either via a Grasshopper plug-in or its Python API.
22+
`diffCheck` can also function as a general purpose point cloud processing toolset and we hope that the digital community will use it, see the interest, and contribute to this open-source project we starting!
2323

24-
Visit the [DiffCheck website](https://diffcheckorg.github.io/diffCheck/) for more information and documentation.
24+
`diffCheck` is originally developed and now maintained by Andrea Settimi (PhD), Damien Gilliard (PhD) from the [Laboratory of Timber Construction (IBOIS, lab head: Prof. Yves Weinand)](https://www.epfl.ch/labs/ibois/), Eleni Skevaki (PhD) and Dr. Marirena Kladeftira (Post-Doc) from the [Laboratory for Creative Computation (CRCL, lab head: Prof. Stefana Parascho)](https://www.epfl.ch/labs/crcl/) here at [Ecole Polytechnique Fédérale de Lausanne (EPFL)](https://www.epfl.ch/en/).
2525

26-
The software is developed by the [Laboratory of Timber Construction (IBOIS)](https://www.epfl.ch/labs/ibois/) and the [Laboratory for Creative Computation (CRCL)](https://www.epfl.ch/labs/crcl/) at [Polytechnique Fédérale de Lausanne (EPFL)](https://www.epfl.ch/en/).
26+
`diffCheck` is designed to be user-friendly and can be used either via a Grasshopper plug-in, we provide tutorials and online documentation for each component and its Python API.
27+
28+
## Quickstart
29+
30+
The main interface is a Grasshopper plug-in, it's distributed via the yak package manager so just type the `_PackageManager` in Rhino and type
31+
32+
```
33+
diffCheck
34+
```
35+
36+
Open your Grasshopper canvas and search for the `DF` components!
37+
38+
## Functionalities
39+
40+
`diffCheck` is a toolset that allows you to compare a 3D model of a structure to evaluate its assembly or joint's quality and accuracy.
41+
42+
<div align="center">
43+
<img src="./assets/img/placeholder_additive.png" width="600">
44+
<p>Example of several structures assembled with different digital technologies.</p>
45+
</div>
46+
<div align="center">
47+
<img src="./assets/img/placeholder_subtractive.png" width="600">
48+
<p>Example of joinery evaluation.</p>
49+
</div>
50+
51+
52+
## Documentation
53+
54+
The full documentation, with tutorials, automatic documentation for GHComponents and PythonAPI is available [here](https://diffcheckorg.github.io/diffCheck/).
2755

2856

2957
## Roadmap
@@ -51,3 +79,20 @@ gantt
5179
Fabrication of Robot Prototype :crit, fabrob, 2024-07-01, 2024-08-30
5280
Data collection and evaluation :dataeval, after fabrob, 4w
5381
```
82+
83+
## How to contribute
84+
85+
If you want to contribute to the project, please refer to the [contribution guidelines]([./CONTRIBUTING.md](https://diffcheckorg.github.io/diffCheck/contribute.html)).
86+
87+
## How to cite
88+
89+
If you use diffCheck in your research, while we are preparing the publication, please cite the software as:
90+
91+
```bibtex
92+
@software{diffCheck,
93+
doi = {10.5281/ZENODO.13843959},
94+
url = {https://github.com/diffCheckOrg/diffCheck},
95+
author = {A. Settimi, and D. Gilliard, and E. Skevaki, M. Kladeftira, and J. Gamerro, and S. Parascho, and Y. Weinand many others},
96+
title = {diffCheckOrg/diffCheck: v1.0.0: diffCheck v1},
97+
year = {2024}
98+
}
956 KB
Loading
963 KB
Loading

0 commit comments

Comments
 (0)