Skip to content
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.

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

Update installation guide for Windows (tcnn+gsplat) #3212

Merged
merged 2 commits into from
Jun 11, 2024
Merged
Changes from all commits
Commits
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
48 changes: 46 additions & 2 deletions docs/quickstart/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Install [Git](https://git-scm.com/downloads).

Install Visual Studio 2022. This must be done before installing CUDA. The necessary components are included in the `Desktop Development with C++` workflow (also called `C++ Build Tools` in the BuildTools edition).

Install Visual Studio Build Tools. If MSVC 143 does not work (usually will fail if your version > 17.10), you may also need to install MSVC 142 for Visual Studio 2019. Ensure your CUDA environment is set up properly.

Nerfstudio requires `python >= 3.8`. We recommend using conda to manage dependencies. Make sure to install [Conda](https://docs.conda.io/en/latest/miniconda.html) before proceeding.

:::::
Expand Down Expand Up @@ -76,14 +78,56 @@ conda install -c "nvidia/label/cuda-11.7.1" cuda-toolkit
:::
::::

### tiny-cuda-nn
### Installing tinycudann/gsplat

After pytorch and ninja, install the torch bindings for tiny-cuda-nn:
::::::{tab-set}
:::::{tab-item} Linux

After pytorch and ninja, install the torch bindings for tiny-cuda-nn:
@@ -84,6 +85,46 @@ After pytorch and ninja, install the torch bindings for tiny-cuda-nn:
```bash
pip install ninja git+https://github.com/NVlabs/tiny-cuda-nn/#subdirectory=bindings/torch
```

:::::
:::::{tab-item} Windows

Activate your Visual C++ environment:
Navigate to the directory where `vcvars64.bat` is located. This path might vary depending on your installation. A common path is:

```
C:\Program Files (x86)\Microsoft Visual Studio\2022\BuildTools\VC\Auxiliary\Build
```

Run the following command:
```bash
./vcvars64.bat
```

If the above command does not work, try activating an older version of VC:
```bash
./vcvarsall.bat x64 -vcvars_ver=<your_VC++_compiler_toolset_version>
```
Replace `<your_VC++_compiler_toolset_version>` with the version of your VC++ compiler toolset. The version number should appear in the same folder.

For example:
```bash
./vcvarsall.bat x64 -vcvars_ver=14.29
```

Install `gsplat` from source:
```bash
pip install git+https://github.com/nerfstudio-project/gsplat.git
```

Install the torch bindings for tiny-cuda-nn:
```bash
pip install git+https://github.com/NVlabs/tiny-cuda-nn/#subdirectory=bindings/torch
```

:::::
::::::

## Installing nerfstudio

**From pip**
Expand Down
Loading