Skip to content

chore(docs): Update docs to reflect support for macOS #371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ekiefl wants to merge 2 commits into
base: main
Choose a base branch
from
+8 −3
Open

chore(docs): Update docs to reflect support for macOS #371

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9dec652
Update README with info about macOS support
ekiefl Aug 13, 2026
4f0a73d
Merge branch 'main' into ek/clarify-macos-support-in-docs
ekiefl Aug 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
Loading