diff --git a/README.md b/README.md index 7b901e09..0ad5076b 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,8 @@ Chrispens, K., Collins, M., Mai, D., Wankowicz, S. A., Fraser, J. S., & van den **Requirements**: Linux x86-64, CUDA 12, Python ≥ 3.11, < 3.14 +> **Note**: macOS (arm64) is supported for local development. The environments that pull CUDA builds are `linux-64` only; `pixi install -a` installs the rest, which is enough to develop and test most of the codebase. + ### 1. Install Pixi ```bash @@ -34,12 +36,15 @@ curl -fsSL https://pixi.sh/install.sh | sh ```bash git clone git@github.com:diff-use/sampleworks.git cd sampleworks -pixi install -a # install all environments ``` -> **Note**: `pixi install -a` resolves all environments. This (currently) requires CUDA 12 and will fail on machines without it. +Sampleworks is split across several Pixi environments: one per generative model, plus environments for analysis and development. For a complete list, run `pixi workspace environment list`. To install all that are compatible with your machine, run: + +```bash +pixi install -a +``` -Each generative model has its own Pixi environment. Install only what you need: +Alternatively, install only what you need: ```bash pixi install -e boltz # Boltz-1 / Boltz-2