Menu
Overview of the main directories and important files in the repository. Use this to understand the project layout and find where code lives.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
Build and test the libuipc project using XMake. Use when building with xmake, running xmake f / xmake build / xmake run commands, selecting release/releasedbg/debug modes, or running Catch2 tests produced by xmake.
Build and test the libuipc project using CMake. Use when building the project, running cmake configure/build commands, compiling with RelWithDebInfo, running Catch2 tests, or when the user asks how to build or test libuipc.
General simulation development best practices for correctness, stability, and debuggability. Use when implementing or modifying simulation systems, solvers, constraints, or GPU kernels, especially for index safety, NaN/Inf issues, and diagnostics.
Review a libuipc pull request end-to-end: checkout the PR, summarize changes, list files for the human reviewer, and perform a domain-aware AI review covering physics correctness, backend architecture, C++ style, GPU code, and Python bindings. Optionally post review comments via `gh`. Use when the user provides a PR number, asks to review a PR, or wants to inspect a libuipc GitHub PR.
Push a version tag and optionally create a GitHub release
Conventional commit message format and rules for this project
| name | project-structure |
| description | Overview of the main directories and important files in the repository. Use this to understand the project layout and find where code lives. |
Overview of the main directories and important files in the repository.
apps/ - C++ apps, benchmarks, examples, and tests (see apps/CMakeLists.txt).assets/ - Scene assets and simulation data.cmake/ - Shared CMake utilities and macros.docs/ - Documentation, specs, and site assets.external/ - Third-party dependencies (e.g., external/muda/).include/ - Public C++ headers.output/ - Generated outputs from simulations. (the contents is ignored by git)python/ - Python package, tests, and metadata.scripts/ - Utility scripts and notebooks.src/ - Core C++ implementation.xmake/ - XMake rules and build helpers.apps/app/ - Shared app utilities and test helpers.benchmarks/ - Benchmark executables.examples/ - Example applications (each in its own subfolder).tests/ - C++ test suites grouped by feature area.assets/scenes/ - Scene README and references.sim_data/ - Mesh assets (linemesh/, tetmesh/, trimesh/).docs/build_install/ - Build and install guides.development/ - Developer docs and diagrams.specification/ - API/spec references and constitutions.tutorial/ - Tutorial content and media.overrides/ - MkDocs HTML overrides.stylesheets/ - Docs CSS.javascripts/ - Docs JS.media/ - Images for docs pages.misc/ - Miscellaneous documentation.external/muda/ - Third-party CUDA/math dependency (source + docs + tests).include/uipc/ - Public headers grouped by module (backend, core, geometry, io, etc.).uipc_gui/ - Public GUI-related headers. (now not supported)python/src/uipc/ - Pure python code to enhance the C++ pybind11 bindings.tests/ - Python test suite.scripts/optional_import/ - Optional dependency loaders.symbol_calculation/ - Symbolic derivation notebooks and helpers.SymEigen/ - SymEigen utilities, notebooks, and tests.src/backends/ - Backend implementations (common/, cuda/, none/).
common/ - Common utilities for all backends.cuda/ - CUDA backend with CUDA kernels.none/ - An empty backend that does nothing, as a template for creating a new backend or checking the basic functionality.constitution/ - Physical constitution implementations.core/ - Core engine systems and modules.geometry/ - Geometry algorithms and data types.gui/ - GUI runtime components. (now not supported)io/ - Serialization and I/O.pybind/ - C++/Python bindings.sanity_check/ - Internal scene sanity checks to ensure the correctness of scene before the simulation.usd/ - USD integration.vdb/ - VDB integration.