Skip to content

Commit b9a841f

Browse files
committed
Update license information and enhance documentation regarding usage rights
1 parent 91f442e commit b9a841f

File tree

6 files changed

+94
-4
lines changed

6 files changed

+94
-4
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2020 IPC-Sim
3+
Copyright (c) 2020–2025 Zachary Ferguson
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,4 +89,8 @@ Additionally, you can cite the original IPC paper:
8989

9090
## License
9191

92-
MIT License © 2020, the IPC-Sim organization (See <a href="https://github.com/ipc-sim/ipc-toolkit/blob/main/LICENSE"><code>LICENSE</code></a> for details).
92+
This project is licensed under the MIT License.
93+
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 <a href="https://github.com/ipc-sim/ipc-toolkit/blob/main/LICENSE"><code>LICENSE</code></a> file.
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.

docs/PYPI_README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,4 +82,8 @@ Additionally, you can cite the original IPC paper:
8282

8383
## License
8484

85-
MIT License © 2020, the IPC-Sim organization (See <a href="https://github.com/ipc-sim/ipc-toolkit/blob/main/LICENSE"><code>LICENSE.txt</code></a> for details)
85+
This project is licensed under the MIT License.
86+
87+
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 <a href="https://github.com/ipc-sim/ipc-toolkit/blob/main/LICENSE"><code>LICENSE</code></a> file.
88+
89+
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.

docs/source/cpp-api/index.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
C++ API
2+
=======
3+
4+
.. list-table::
5+
:header-rows: 1
6+
7+
* - Name
8+
- Description
9+
* - `Adhesion <adhesion.rst>`__
10+
- Adhesion potential functions.
11+
* - `Barrier <barrier/index.rst>`__
12+
- Barrier functions and functionals.
13+
* - `Broad Phase <broad_phase.rst>`__
14+
- Algorithms for broad phase collision detection.
15+
* - `Candidates <candidates.rst>`__
16+
- Structures and utilities for collision candidates.
17+
* - `Continuous Collision Detection <ccd.rst>`__
18+
- Methods for detecting collisions over continuous motion.
19+
* - `Collision Mesh <collision_mesh.rst>`__
20+
- Data structures representing collision meshes.
21+
* - `Distance <distance.rst>`__
22+
- Functions for computing distances between geometric entities.
23+
* - `Friction <friction.rst>`__
24+
- Models and functions for frictional contact.
25+
* - `Intersections <intersections.rst>`__
26+
- Algorithms for detecting intersections between primitives.
27+
* - `Interval Arithmetic <interval.rst>`__
28+
- Utilities for interval arithmetic operations.
29+
* - `Normal Collisions <normal_collisions.rst>`__
30+
- Functions for handling normal contact collisions.
31+
* - `Potentials <potentials/index.rst>`__
32+
- General potential energy functions for contact modeling.
33+
* - `Tangent <tangent.rst>`__
34+
- Utilities for tangent vector computations.
35+
* - `Tangential Collisions <tangential_collisions.rst>`__
36+
- Functions for handling tangential contact collisions.
37+
* - `Utils <utils.rst>`__
38+
- Miscellaneous utility functions and helpers.

docs/source/index.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
:caption: C++ API
3333
:hidden:
3434

35+
Index <cpp-api/index.rst>
3536
cpp-api/adhesion.rst
3637
cpp-api/barrier/index.rst
3738
cpp-api/broad_phase.rst
@@ -52,6 +53,7 @@
5253
:caption: Python API
5354
:hidden:
5455

56+
Index <python-api/index.rst>
5557
python-api/adhesion.rst
5658
python-api/barrier.rst
5759
python-api/broad_phase.rst
@@ -151,4 +153,8 @@ IPC Toolkit is created and maintained by academics: citations let us know our wo
151153
152154
**License**
153155

154-
MIT License © 2020, the IPC-Sim organization (See `License <license.html>`_ for details).
156+
This project is licensed under the MIT License.
157+
158+
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 `License <license.html>`_ file.
159+
160+
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.

docs/source/python-api/index.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
C++ API
2+
=======
3+
4+
.. list-table::
5+
:header-rows: 1
6+
7+
* - Name
8+
- Description
9+
* - `Adhesion <adhesion.rst>`__
10+
- Adhesion potential functions.
11+
* - `Barrier <barrier.rst>`__
12+
- Barrier functions and functionals.
13+
* - `Broad Phase <broad_phase.rst>`__
14+
- Algorithms for broad phase collision detection.
15+
* - `Candidates <candidates.rst>`__
16+
- Structures and utilities for collision candidates.
17+
* - `Continuous Collision Detection <ccd.rst>`__
18+
- Methods for detecting collisions over continuous motion.
19+
* - `Collision Mesh <collision_mesh.rst>`__
20+
- Data structures representing collision meshes.
21+
* - `Distance <distance.rst>`__
22+
- Functions for computing distances between geometric entities.
23+
* - `Friction <friction.rst>`__
24+
- Models and functions for frictional contact.
25+
* - `Intersections <intersections.rst>`__
26+
- Algorithms for detecting intersections between primitives.
27+
* - `Interval Arithmetic <interval.rst>`__
28+
- Utilities for interval arithmetic operations.
29+
* - `Normal Collisions <normal_collisions.rst>`__
30+
- Functions for handling normal contact collisions.
31+
* - `Potentials <potentials.rst>`__
32+
- General potential energy functions for contact modeling.
33+
* - `Tangent <tangent.rst>`__
34+
- Utilities for tangent vector computations.
35+
* - `Tangential Collisions <tangential_collisions.rst>`__
36+
- Functions for handling tangential contact collisions.
37+
* - `Utils <utils.rst>`__
38+
- Miscellaneous utility functions and helpers.

0 commit comments

Comments
 (0)