Installation

Requirements

Cheese3D is a Python package with a few external dependencies. Our environment is managed by Pixi. Install Pixi using (on macOS or Windows):

curl -fsSL https://pixi.sh/install.sh | sh

Setup

Warning

We are currently upstreaming changes in order to publish Cheese3D on PyPi. Until then, follow the instructions below to install Cheese3D directly from Github.

Clone the Cheese3D repository:

git clone https://github.com/Hou-Lab-CSHL/cheese3d.git

Setup the environment then activate it. Any future commands require activating the environment first.

cd cheese3d
pixi shell

Platform-specific support

Support matrix

Platform	Basic support	GPU acceleration
Linux	✅	✅
macOS (Apple Silicon)	✅	✅
macOS (Intel)	✅	❌
Windows	🚧	❌