Skip to content

Commit aad6084

Browse files
committed
updating the instructions (not finished)
1 parent b42c1a7 commit aad6084

File tree

1 file changed

+3
-50
lines changed

1 file changed

+3
-50
lines changed

README.md

Lines changed: 3 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ Opinionated COMPAS-compatible bindings for top-level algorithms of libigl.
88
* COMPAS
99
* CMake
1010
* Boost
11+
* Eigen3
1112

1213
Anaconda 3 can be obtained from the official website. With `conda` installing COMPAS is as simple as `$ conda install COMPAS`. Make sure you have the latest version of COMPAS. You can check the version by typing `python -c “import compas; print(compas.__version__)` in terminal.
1314

1415
## Git Submodules
1516

1617
* libigl
1718
* PyBind11
18-
* Eigen
1919

2020
These are configured in the `.gitmodules` file and will be cloned into the `ext` folder.
2121

@@ -46,9 +46,10 @@ conda activate igl
4646
> On Mac, don't forget to add `python.app`
4747
4848
To make sure that you can build the modules that require `CGAL`, you should also install `Boost` into this environment.
49+
We also switched to use the `Eigen3` of `conda`. Therefore also install `Eigen3`.
4950

5051
```bash
51-
conda install boost
52+
conda install boost eigen
5253
```
5354

5455
> Note that a conda install of Boost into an environment with Python 3.x will install Boost 1.70 and this is only supported since CMake 3.14.
@@ -106,51 +107,3 @@ To build `compas_libigl` with support for boolean operations, modify the followi
106107

107108
* uncomment line 5 (`# from .booleans import *`)
108109
* uncomment line 6 (`# from .csgtree import *`)
109-
110-
## Cmake
111-
112-
The project has three levels of `CMakeLists.txt` files.
113-
114-
### /CMakeLists.txt
115-
116-
The top level file is located at the root of the project.
117-
118-
### /modules/CMakeLists.txt
119-
120-
The second level file is in the `modules` folder. If you add a new wrapper module, make sure to register it in this file as well.
121-
122-
```make
123-
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/xxx)
124-
```
125-
126-
### /modules/xxx/CMakeLists.txt
127-
128-
Finally there is a `CMakeLists` file per wrapper module. There the most relevant part is to link the correct libraries. For example, the module that wraps `libigl`'s boolean operations requires `CGAL` and this should thus be reflected in the file.
129-
130-
```make
131-
target_link_libraries(booleans PRIVATE igl::cgal)
132-
```
133-
134-
## Notes
135-
136-
### Related projects
137-
138-
* [PyMesh](https://github.com/PyMesh/PyMesh)
139-
* [PyTriangle](https://github.com/pletzer/pytriangle)
140-
* [Triangle](https://github.com/drufat/triangle)
141-
* [CMake Triangle](https://github.com/wo80/Triangle)
142-
* [Projects in C](https://userpages.umbc.edu/~rostamia/cbook/triangle.html)
143-
* [cppimport](https://github.com/tbenthompson/cppimport)
144-
145-
### PyBind
146-
147-
* [PyBind: building with cmake](https://pybind11.readthedocs.io/en/stable/compiling.html#building-with-cmake)
148-
* [PyBind: building manually](https://pybind11.readthedocs.io/en/stable/compiling.html#building-manually)
149-
* <https://github.com/pybind/pybind11/issues/134>
150-
* <https://github.com/pybind/pybind11/issues/1200>
151-
* <https://pybind11.readthedocs.io/en/stable/advanced/cast/stl.html>
152-
153-
### SO
154-
155-
* <https://stackoverflow.com/questions/16439654/how-can-i-compile-triangle-using-makefiles-on-a-windows-machine>
156-
* <https://stackoverflow.com/questions/1099981/why-cant-python-find-shared-objects-that-are-in-directories-in-sys-path>

0 commit comments

Comments
 (0)