You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,19 +16,19 @@ IPC Toolkit is a set of reusable functions to integrate Incremental Potential Co
16
16
17
17
### Features
18
18
19
-
* IPC barrier function and its derivatives and adaptive barrier stiffness algorithm
19
+
* IPC barrier function and its derivatives, and adaptive barrier stiffness algorithm
20
20
* Broad- and narrow-phase continuous collision detection (CCD) of linear and nonlinear trajectories
21
21
* Distance computation and derivatives between edges in 2D and triangles in 3D
22
22
* Distance barrier potential and its derivatives
23
23
* Smooth and lagged dissipative friction potential and its derivatives
24
24
25
25
### Limitations
26
26
27
-
This is not a full simulation library. As such it does not include any physics or solvers. For a full simulation implementation, we recommend [PolyFEM](https://polyfem.github.io/) (a finite element library) or [Rigid IPC](https://github.com/ipc-sim/rigid-ipc) (rigid-body dynamics) both of which utilize the IPC Toolkit.
27
+
This is not a full simulation library. As such, it does not include any physics or solvers. For a full simulation implementation, we recommend [PolyFEM](https://polyfem.github.io/) (a finite element library) or [Rigid IPC](https://github.com/ipc-sim/rigid-ipc) (rigid-body dynamics), both of which utilize the IPC Toolkit.
28
28
29
29
## Build
30
30
31
-
Instruction for building and including the IPC Toolkit in your CMake project can be found on the website [here](https://ipctk.xyz/build.html).
31
+
Instructions for building and including the IPC Toolkit in your CMake project can be found on the website [here](https://ipctk.xyz/build/c++.html).
32
32
33
33
### Dependencies
34
34
@@ -42,7 +42,7 @@ A full list of dependencies can be found on the [dependencies page](https://ipct
42
42
43
43
We provide Python bindings for functions in the toolkit using [pybind11](https://github.com/pybind/pybind11).
44
44
45
-
For more information see the [Python documentation](https://ipctk.xyz/python.html).
45
+
For more information, see the [Python documentation](https://ipctk.xyz/python.html).
46
46
47
47
## Usage
48
48
@@ -61,7 +61,7 @@ Simply fork this repository and make a Pull Request! We would appreciate:
61
61
62
62
## Citation
63
63
64
-
IPC Toolkit is created and maintained by academics: citations let us know our work is having impact! Please cite the IPC Toolkit or otherwise give a shout-out if and when it contributes to published works.
64
+
The IPC Toolkit is created and maintained by academics: citations let us know our work is having an impact! Please cite the IPC Toolkit or otherwise give a shout-out if and when it contributes to published works.
65
65
66
66
```bibtex
67
67
@software{ipc_toolkit,
@@ -93,4 +93,4 @@ This project is licensed under the MIT License.
93
93
94
94
You are free to use, modify, and distribute this code in your projects, even commercial ones, as long as you include the original copyright and license notice. A copy of the full license text can be found in the <ahref="https://github.com/ipc-sim/ipc-toolkit/blob/main/LICENSE"><code>LICENSE</code></a> file.
95
95
96
-
If you use this code in a product you distribute to others, you are required to **include a copy of the original copyright and license notice**. This is typically done in the product's documentation, an "About" or "Third-Party Licenses" section, or in a clear open-source software statement.
96
+
If you use this code in a product you distribute to others, you are required to **include a copy of the original copyright and license notice**. This is typically done in the product's documentation, an "About" or "Third-Party Licenses" section, or in a clear open-source software statement.
Copy file name to clipboardExpand all lines: docs/source/build/c++.rst
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,6 +53,8 @@ You can build the IPC Toolkit using CMake as you would any other CMake project.
53
53
54
54
This will build the IPC Toolkit and all of its dependencies. The ``IPC_TOOLKIT_BUILD_TESTS`` option enables building the unit tests, and the ``IPC_TOOLKIT_BUILD_PYTHON`` option enables building the Python bindings.
55
55
56
+
CUDA support is disabled by default. Enable it by setting CMake option ``IPC_TOOLKIT_WITH_CUDA`` to ON.
57
+
56
58
.. warning::
57
59
Installing the IPC Toolkit using the ``make install`` has not been tested and is not recommended. The IPC Toolkit is designed to be used as a submodule in your project, and as such does not have a proper install target.
58
60
@@ -61,4 +63,4 @@ Dependencies
61
63
62
64
**All required dependencies are downloaded through CMake** depending on the build options, and are built automatically when you build the IPC Toolkit. You do not need to install them separately.
63
65
64
-
A full list of dependencies can be found on the `dependencies page <https://ipctk.xyz/dependencies.html>`_.
66
+
A full list of dependencies can be found on the `dependencies page <https://ipctk.xyz/dependencies.html>`_.
0 commit comments