TRELLIS-install-windows

Install instructions for a working build of TRELLIS on Windows Operating system. Tested with Windows 11, Python 3.10, CUDA 12.4, and VS Build Tools 2022.

Inspiration

These instructions were a culmination of resources including TRELLIS/setup.sh, TRELLIS/Issues/3, and sdbds/TRELLIS-for-Windows.

Issues and Resolutions

Conda

Issue: Conda licenses have changed and to ensure that we are not violating the Enterprise (company more than 200 employees) licensing limitation I selected a solution not using conda.
Solution: Use Python venv instead.

Python Wheels won't build

Issue: Python installation or venv does not include the Python build libraries (Python.h).
Solution: Ensure that the Python build you are using includes the Python.h. On non-windows this is included in python-dev, but this is not supported on Windows. The standard Windows installer (xxxxx) builds include this, but the Windows embeddable pakage (xxxxx) does not. Verify that your install includes Python###\include\Python.h.

Issue: File "subprocess.py", line 526, in run subprocess.CalledProcessError: Command '['ninja', '-v']' returned non-zero exit status 1.
Solution: Ensure you are using setuptools==75.8.2.

Issue: I don't know the minimum Visual Studio needed to build.
Solution: Ensure you are using Desktop development with C++.

Gradio won't launch

Issue: Trying to run app.py throws ERROR: Exception in ASGI application.
Solution: Ensure you are using pydantic==2.10.6.

Issue: ModuleNotFoundError: No module named 'open3d'.
Solution: Ensure you are using open3d==0.19.0.

Successful Build

Prerequistes

Build Tools for Visual Studio 2022
CUDA 12.4
Python 3.10.11
Download requirements-torch.txt, place in same folder as TRELLIS-install.bat.
Download requirements-other.txt, place in same folder as TRELLIS-install.bat.
Download and run TRELLIS-install.bat, or follow manual steps below.

Manual Install Process (cmd\bat)

Visual Studio Build Tools 2022

vs_buildtools.exe --norestart --passive --add Microsoft.VisualStudio.Workload.VCTools --includeRecommended

Clone TRELLIS Repo

git clone --recurse-submodules https://github.com/microsoft/TRELLIS.git
CD TRELLIS

Virtual Environment Setup

py -3.10 -m venv "trellis-venv"
call trellis-venv\scripts\activate.bat

Update pip, wheel, setuptools

python -m pip install --upgrade pip wheel
python -m pip install setuptools==75.8.2

Requirements Install

pip install -r requirements-torch.txt
pip install -r requirements-other.txt

Environment Variables (optional) and app.py launch

set ATTN_BACKEND=flash-attn
set SPCONV_ALGO=native
set XFORMERS_FORCE_DISABLE_TRITON=1

python ./app.py