// 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.
| name | cmake-workflow |
| description | 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. |
The build directory is libuipc/build. Run all cmake commands from there.
Configure:
cd libuipc/build
cmake -S ..
Build:
cmake --build . -j32 --config RelWithDebInfo
Use -j32 for parallel compilation. The config is always RelWithDebInfo.
Tests use Catch2. After a successful build, run the test executable directly — no separate test runner command is needed.
Find the compiled test binary in the build output (typically under libuipc/build/bin/ or the relevant subdirectory) and execute it:
./path/to/test_executable
Catch2 test binaries accept standard flags such as:
--list-tests — list all test cases[tag] — filter by tag"test name" — run a specific test by name| Step | Command |
|---|---|
| Configure | cmake -S .. (from libuipc/build) |
| Build | cmake --build . -j32 --config RelWithDebInfo |
| Run tests | Execute the test binary directly |
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.
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
Create a well-formatted conventional commit