Development Installation

If you want to do any development in the viseg repo this section will tell you how to set this up.

Environment Set-Up

Clone the repo and then set-up pixi with:

# all default dependencies
pixi install

# for cuda enabled
pixi install -e cuda

# all dev and cuda deps
pixi install -e cuda-dev

If you want to commit any code to the repo, also install the ruff pre-commit hooks with:

pre-commit install

This will make sure that your code is checked (and potentially reformatted) with ruff before you can commit. Always make sure that the ruff version in the .pre-commit-config.yaml is identical to the ruff version in the dev environment (in the pyproject.toml) so that the Github action runner uses the same ruff version as your pre-commit hook.

Pixi tasks

Some preconfigured commands are now provided as pixi tasks. A full list of available tasks can be seen by running pixi task ls.