Reorganize documentation (#631)

restructure_docs
This commit is contained in:
Matthew Tancik authored and GitHub committed 2022-10-03 12:59:46 -07:00
1 parent 5a76b955cd
commit d7c34ca2bd
68 files changed
+87 -148

No files matched your search

+56
View File
@@ -0,0 +1,56 @@
# Installation
### Create environment
We reccomend using conda to manage dependencies. Make sure to install [Conda](https://docs.conda.io/en/latest/miniconda.html) before preceding.
```bash
conda create --name nerfstudio -y python=3.8.13
conda activate nerfstudio
python -m pip install --upgrade pip
```
### Dependencies
Install pytorch with CUDA (this repo has been tested with CUDA 11.3) and [tiny-cuda-nn](https://github.com/NVlabs/tiny-cuda-nn)
```bash
pip install torch==1.12.1+cu113 torchvision==0.13.1+cu113 -f https://download.pytorch.org/whl/torch_stable.html
pip install git+https://github.com/NVlabs/tiny-cuda-nn/#subdirectory=bindings/torch
```
### Installing nerfstudio
Easy option:
```bash
pip install nerfstudio
```
If you would want the latest and greatest:
```bash
git clone git@github.com:plenoptix/nerfstudio.git
cd nerfstudio
pip install -e .
```
### Optional Installs
#### Tab completion (bash & zsh)
This needs to be rerun when the CLI changes, for example if nerfstudio is updated.
```bash
ns-install-cli
```
### Development packages
```bash
pip install -e.[dev]
pip install -e.[docs]
```