README.md

GenMetaBalls

Let's get the ball rolling with blazing fast CUDA kernels!

Installation

Usage Setup

To simply run genmetaballs:

pixi install

Development Setup

For development, make sure Mesa is installed and then set up hooks.

sudo apt install mesa-common-dev
pixi install
pixi run dev-setup # set-up hooks

The dev-setup task sets up pre-commit git hooks:

• Pre-commit: Formats and lints code before each commit
• Pre-push: Runs all tests before pushes

Testing

C++/CUDA Tests

C++/CUDA tests are configured using Google Test (powered by ctest). Run them with:

pixi run ctest

Python Tests

Python tests are configured using pytest. Run them with:

pixi run pytest

Run All Tests

To run both C++/CUDA and Python tests together:

pixi run test

Formatting & Linting

All commands work on both C++/CUDA and Python files automatically.

Format all files:

pixi run format

Lint all files:

pixi run lint

Auto-fix linting issues and format files:

pixi run fix

These commands are automatically run by the pre-commit hooks when you commit code.