tink/nerfstudio
4
0
Fork 0
mirror of https://github.com/nerfstudio-project/nerfstudio.git synced 2026-11-10 18:17:31 +08:00
Code

installation.md: Remove manual gsplat installation for Windows (#3333)

Browse Source 
* installation.md: Remove manual gsplat installation for Windows

* installation.md: Reformat and clarify Windows instructions.

* Update installation.md

installation.md: Minor change in wording

---------

Co-authored-by: J.Y. <132313008+jb-ye@users.noreply.github.com>
This commit is contained in:
Sebastiaan 2024-08-19 17:44:41 +02:00 committed by GitHub
parent c669d865c1
commit 096116097a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 42 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
docs/quickstart/installation.md
View File

@ -10,12 +10,47 @@ Nerfstudio requires `python >= 3.8`. We recommend using conda to manage dependen
:::::
:::::{tab-item} Windows
:::{admonition} Note
:class: info
Nerfstudio on Windows is less tested and more fragile, due to way more moving parts outside of Nerfstudio's control.
The instructions also tend to break over time as updates to different Windows packages happen.
Installing Nerfstudio on Linux instead is recommended if you have the option.
Alternatively, installing Nerfstudio under WSL2 (temporary unofficial guide [here](https://gist.github.com/SharkWipf/0a3fc1be3ea88b0c9640db6ce15b44b9), not guaranteed to work) is also an option, but this comes with its own set of caveats.
:::
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.
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
```
:::{admonition} Note
:class: info
When updating, or if you close your terminal before you finish the installation and run your first `splatfacto`, you have to re-do this environment activation step.
:::
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.
:::::
@ -78,7 +113,7 @@ conda install -c "nvidia/label/cuda-11.7.1" cuda-toolkit
:::
::::
### Install tiny-cuda-nn/gsplat
### Install tiny-cuda-nn
::::::{tab-set}
:::::{tab-item} Linux
@ -91,34 +126,6 @@ pip install ninja git+https://github.com/NVlabs/tiny-cuda-nn/#subdirectory=bindi
:::::
:::::{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
@ -436,3 +443,9 @@ export CUDA_HOME=/usr/local/cuda
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/cuda/lib64:/usr/local/cuda/extras/CUPTI/lib64
export PATH=$PATH:$CUDA_HOME/bin
```
**Other errors**
(Windows) A lot of errors on Windows can be caused by not having the Visual Studio environment loaded.
If you run into errors you can't figure out, please try re-activating the Visual Studio environment (as outlined at the top of the Windows instructions on this page) and try again.
This activation only lasts within your current terminal session and does not extend to other terminals, but this should only be needed on first run and on updates.