Skip to content

Commit 88df2d7

Browse files
authored
Merge pull request #628 from ManifoldFR/topic/coal/minor-changes
Minor changes following transition to `coal`
2 parents 4d1b792 + d2671c2 commit 88df2d7

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

CMakeLists.txt

+1
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ cmake_minimum_required(VERSION 3.10)
3636
set(CXX_DISABLE_WERROR TRUE)
3737

3838
set(PROJECT_NAME coal)
39+
set(PROJECT_ORG "coal-library")
3940
set(PROJECT_DESCRIPTION
4041
"Coal, The Collision Detection Library. Previously known as HPP-FCL, fork of FCL -- The Flexible Collision Library"
4142
)

README.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,17 @@
1212
</p>
1313

1414
[FCL](https://github.com/flexible-collision-library/fcl) was forked in 2015, creating a new project called HPP-FCL.
15-
Since then, a large part of the code has been rewritten or removed (for the unused and untested part), and new features have been developped (see below).
15+
Since then, a large part of the code has been rewritten or removed (unused and untested code), and new features have been introduced (see below).
1616
Due to these major changes, it was decided in 2024 to rename the HPP-FCL project to **Coal**.
1717

18-
If you use **Coal** in your projects and research papers, we would appreciate it if you'd [cite it](https://raw.githubusercontent.com/coal-library/coal/devel/CITATION.bib).
18+
If you use **Coal** in your projects and research papers, we would appreciate it if you would [cite it](https://raw.githubusercontent.com/coal-library/coal/devel/CITATION.bib).
1919

2020
## New features
2121

2222
Compared to the original [FCL](https://github.com/flexible-collision-library/fcl) library, the main new features are:
2323
- dedicated and efficient implementations of the GJK and the EPA algorithms (we do not rely on [libccd](https://github.com/danfis/libccd))
2424
- the support of safety margins for collision detection
25-
- an accelerated version of collision detection *à la Nesterov*, which leads to increased performances (up to a factor of 2). More details are available in this [paper](https://hal.archives-ouvertes.fr/hal-03662157/)
25+
- an accelerated version of collision detection *à la Nesterov*, which leads to increased performance (up to a factor of 2). More details are available in this [paper](https://hal.archives-ouvertes.fr/hal-03662157/)
2626
- the computation of a lower bound of the distance between two objects when collision checking is performed, and no collision is found
2727
- the implementation of Python bindings for easy code prototyping
2828
- the support of new geometries such as height fields, capsules, ellipsoids, etc.
@@ -32,13 +32,14 @@ Compared to the original [FCL](https://github.com/flexible-collision-library/fcl
3232

3333
Note: the broad phase was reintroduced by [Justin Carpentier](https://github.com/jcarpent) in 2022, based on the FCL version 0.7.0.
3434

35-
This project is now used in many robotics frameworks such as [Pinocchio](https://github.com/stack-of-tasks/pinocchio), an open-source software that implements efficient and versatile rigid body dynamics algorithms, the [Humanoid Path Planner](https://humanoid-path-planner.github.io/hpp-doc), an open-source software for Motion and Manipulation Planning. **Coal** has also been recently used to develop [Simple](https://github.com/Simple-Robotics/Simple), a new (differentiable) and efficient simulator for robotics and beyond.
35+
This project is now used in several robotics frameworks such as [Pinocchio](https://github.com/stack-of-tasks/pinocchio), an open-source library which implements efficient and versatile rigid-body dynamics algorithms, the [Humanoid Path Planner](https://humanoid-path-planner.github.io/hpp-doc), an open-source library for Motion and Manipulation Planning. **Coal** has recently also been used to develop [Simple](https://github.com/Simple-Robotics/Simple), a new (differentiable) and efficient simulator for robotics and beyond.
3636

3737
## A high-performance library
3838

39-
Unlike the original FCL library, Coal implements the well-established [GJK algorithm](https://en.wikipedia.org/wiki/Gilbert%E2%80%93Johnson%E2%80%93Keerthi_distance_algorithm) and [its variants](https://hal.archives-ouvertes.fr/hal-03662157/) for collision detection and distance computation. These implementations lead to state-of-the-art performances, as depicted by the figures below.
39+
Unlike the original FCL library, Coal implements the well-established [GJK algorithm](https://en.wikipedia.org/wiki/Gilbert%E2%80%93Johnson%E2%80%93Keerthi_distance_algorithm) and [its variants](https://hal.archives-ouvertes.fr/hal-03662157/) for collision detection and distance computation. These implementations lead to state-of-the-art performance, as shown in the figures below.
40+
41+
On the one hand, we have benchmarked Coal against major state-of-the-art software alternatives:
4042

41-
On the one hand, we have benchmarked Coal against major software alternatives of the state of the art:
4243
1. the [Bullet simulator](https://github.com/bulletphysics/bullet3),
4344
2. the original [FCL library](https://github.com/flexible-collision-library/fcl) (used in the [Drake framework]()),
4445
3. the [libccd library](https://github.com/danfis/libccd) (used in [MuJoCo](http://mujoco.org/)).
@@ -213,4 +214,4 @@ if __name__ == "__main__":
213214

214215
## Acknowledgments
215216

216-
The development of **Coal** is actively supported by the [Gepetto team](http://projects.laas.fr/gepetto/) [@LAAS-CNRS](http://www.laas.fr), the [Willow team](https://www.di.ens.fr/willow/) [@INRIA](http://www.inria.fr) and, to some extend, [Eureka Robotics](https://eurekarobotics.com/).
217+
The development of **Coal** is actively supported by the [Gepetto team](http://projects.laas.fr/gepetto/) [@LAAS-CNRS](http://www.laas.fr), the [Willow team](https://www.di.ens.fr/willow/) [@INRIA](http://www.inria.fr) and, to some extent, [Eureka Robotics](https://eurekarobotics.com/).

0 commit comments

Comments
 (0)