Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
307 changes: 0 additions & 307 deletions docs/CHANGELOG.md

This file was deleted.

3 changes: 3 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,6 @@ breathe
nbsphinx
pandoc
myst_parser==1.0.0
sphinxcontrib-bibtex
sphinxemoji
sphinx-last-updated-by-git
267 changes: 174 additions & 93 deletions docs/source/Doxyfile

Large diffs are not rendered by default.

615 changes: 613 additions & 2 deletions docs/source/changelog.rst

Large diffs are not rendered by default.

12 changes: 9 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
"sphinx.ext.autosummary",
"sphinx.ext.napoleon",
"sphinx.ext.intersphinx",
"sphinx.ext.autosectionlabel",
# "sphinx.ext.autosectionlabel",
"sphinx.ext.todo",
"sphinx.ext.mathjax",
"sphinx.ext.ifconfig",
Expand All @@ -56,8 +56,15 @@
"sphinx_immaterial.apidoc.python.apigen",
"sphinx_immaterial.apidoc.format_signatures",
# 'sphinx_autodoc_toolbox.collapse',
"sphinxcontrib.bibtex",
"sphinxemoji.sphinxemoji",
"sphinx_last_updated_by_git",
]

bibtex_bibfiles = ['refs.bib']
bibtex_reference_style = 'author_year'
bibtex_default_style = 'plain'

myst_enable_extensions = [
"dollarmath",
]
Expand Down Expand Up @@ -178,7 +185,6 @@
# Set the repo location to get a badge with stats
"repo_url": "https://github.com/ipc-sim/ipc-toolkit",
"repo_name": "ipc-sim/ipc-toolkit",
"repo_type": "github",
"icon": {"repo": "fontawesome/brands/github"},

"edit_uri": "blob/main/docs/source",
Expand Down Expand Up @@ -219,4 +225,4 @@
# or fully qualified paths (eg. https://...)
html_css_files = ["css/custom.css"]

html_last_updated_fmt = "%B %d, %Y"
# html_last_updated_fmt = "%B %d, %Y"
25 changes: 16 additions & 9 deletions docs/source/cpp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,18 +64,25 @@ Optional
--------

* `robin-map <https://github.com/Tessil/robin-map>`__: faster hash set/map than :cpp:`std::unordered_set`/:cpp:`std::unordered_map`
* Enable by using the CMake option :cmake:`IPC_TOOLKIT_WITH_ROBIN_MAP`
* Enabled by default

* Enable by using the CMake option :cmake:`IPC_TOOLKIT_WITH_ROBIN_MAP`
* Enabled by default

* `Abseil <https://abseil.io/>`__: hashing utilities
* Enable by using the CMake option :cmake:`IPC_TOOLKIT_WITH_ABSEIL`
* Enabled by default

* Enable by using the CMake option :cmake:`IPC_TOOLKIT_WITH_ABSEIL`
* Enabled by default

* `GMP <https://gmplib.org/>`__: rational arithmetic used for exact intersection checks
* Enable by using the CMake option :cmake:`IPC_TOOLKIT_WITH_RATIONAL_INTERSECTION`
* GMP must be installed at a system level

* Enable by using the CMake option :cmake:`IPC_TOOLKIT_WITH_RATIONAL_INTERSECTION`
* GMP must be installed at a system level

* `Etienne Vouga's Collision Detection Library <https://github.com/evouga/collisiondetection>`__: inexact CCD
* Included for comparison with the original IPC library
* Enable by disabling the CMake option :cmake:`IPC_TOOLKIT_WITH_CORRECT_CCD`
* Replaces the default Tight-Inclusion CCD

* Included for comparison with the original IPC library
* Enable by disabling the CMake option :cmake:`IPC_TOOLKIT_WITH_CORRECT_CCD`
* Replaces the default Tight-Inclusion CCD

Usage
-----
Expand Down
5 changes: 3 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,17 @@
tutorial/getting_started.rst
tutorial/simulation.rst
tutorial/misc.rst
tutorial/references.rst

.. toctree::
:caption: C++
:hidden:

Getting Started <cpp>
cpp-api/collision_mesh.rst
cpp-api/candidates.rst
cpp-api/collision_constraints.rst
cpp-api/friction.rst
cpp-api/candidates.rst
cpp-api/broad_phase.rst
cpp-api/ccd.rst
cpp-api/distance.rst
Expand All @@ -35,9 +36,9 @@

Getting Started <python.md>
python-api/collision_mesh.rst
python-api/candidates.rst
python-api/collision_constraints.rst
python-api/friction.rst
python-api/candidates.rst
python-api/broad_phase.rst
python-api/ccd.rst
python-api/distance.rst
Expand Down
60 changes: 60 additions & 0 deletions docs/source/refs.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
@article{Li2020IPC,
title = {Incremental Potential Contact: Intersection- and Inversion-free Large Deformation Dynamics},
author = {Minchen Li and Zachary Ferguson and Teseo Schneider and Timothy Langlois and Denis Zorin and Daniele Panozzo and Chenfanfu Jiang and Danny M. Kaufman},
year = 2020,
journal = {ACM Transactions on Graphics (SIGGRAPH)},
volume = 39,
number = 4,
articleno = 49,
note = {\url{https://ipc-sim.github.io}}
}
@article{Li2021CIPC,
title = {Codimensional Incremental Potential Contact},
author = {Minchen Li and Danny M. Kaufman and Chenfanfu Jiang},
year = 2021,
journal = {ACM Transactions on Graphics (SIGGRAPH)},
volume = 40,
number = 4,
articleno = 170,
note = {\url{https://ipc-sim.github.io/C-IPC}}
}
@misc{Li2023Convergent,
title = {Convergent Incremental Potential Contact},
author = {Minchen Li and Zachary Ferguson and Teseo Schneider and Timothy Langlois and Denis Zorin and Daniele Panozzo and Chenfanfu Jiang and Danny M. Kaufman},
year = 2023,
eprint = {2307.15908},
archiveprefix = {arXiv},
primaryclass = {math.NA}
}
@article{Wang2021TightInclusion,
title = {A Large Scale Benchmark and an Inclusion-Based Algorithm for Continuous Collision Detection},
author = {Bolun Wang and Zachary Ferguson and Teseo Schneider and Xin Jiang and Marco Attene and Daniele Panozzo},
year = 2021,
month = oct,
journal = {ACM Transactions on Graphics},
volume = 40,
number = 5,
articleno = 188,
numpages = 16,
note = {\url{https://continuous-collision-detection.github.io/tight_inclusion/}}
}
@misc{Belgrod2023Time,
title = {Time of Impact Dataset for Continuous Collision Detection and a Scalable Conservative Algorithm},
author = {David Belgrod and Bolun Wang and Zachary Ferguson and Xin Zhao and Marco Attene and Daniele Panozzo and Teseo Schneider},
year = 2023,
eprint = {2112.06300},
archiveprefix = {arXiv},
primaryclass = {cs.GR}
}
@inproceedings{Ferguson2023HighOrderIPC,
title = {High-Order Incremental Potential Contact for Elastodynamic Simulation on Curved Meshes},
author = {Zachary Ferguson and Pranav Jain and Denis Zorin and Teseo Schneider and Daniele Panozzo},
year = 2023,
booktitle = {{ACM} {SIGGRAPH} 2023 Conference Proceedings},
location = {Los Angeles, CA, USA},
publisher = {Association for Computing Machinery},
address = {New York, NY, USA},
series = {SIGGRAPH '23},
numpages = 11,
note = {\url{https://zferg.us/research/high-order-ipc/}}
}
Loading