installation documentation (#440)

This commit is contained in:
Ethan Weber authored and GitHub committed 2022-09-15 13:18:44 -07:00
1 parent 1d6592b760
commit 1492f84930
3 files changed
+39 -57

No files matched your search

+9 -19
View File
@@ -2,20 +2,6 @@
This repository is tested with CUDA 11.3. Make sure to install [Conda](https://docs.conda.io/en/latest/miniconda.html#linux-installers) before preceding.
<details>
<summary>Installing Conda</summary>
This step is fairly self-explanatory, but here are the basic steps. You can also find countless tutorials online.
```bash
cd /path/to/install/miniconda
mkdir -p miniconda3
wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda3/miniconda.sh
bash miniconda3/miniconda.sh -b -u -p miniconda3
rm -rf miniconda/miniconda.sh
```
</details>
Create the python environment
@@ -23,19 +9,19 @@ Create the python environment
```bash
conda create --name nerfactory python=3.8.13
conda activate nerfactory
python -m pip install --upgrade pip
```
Clone the repo
```bash
git clone git@github.com:plenoptix/nerfactory.git
cd nerfactory
```
Install dependencies and nerfactory as a library
```bash
python -m pip install --upgrade pip
cd nerfactory
pip install -e .
```
@@ -50,7 +36,7 @@ Experimental: install tab completion for nerfactory (bash and zsh)
```bash
# If the CLI changes, we can also re-install to synchronize completions
python scripts/completion/configure.py install
python scripts/completions/configure.py install
```
# Downloading data
@@ -121,27 +107,31 @@ Please note, this quickstart allows you to preform everything in a headless mann
# FAQ
* [TinyCUDA installation errors out with cuda mismatch](tiny-cuda-error)
- [TinyCUDA installation errors out with cuda mismatch](tiny-cuda-error)
(tiny-cuda-error)=
#### TinyCUDA installation errors out with cuda mismatch
While installing tiny-cuda, you run into: `The detected CUDA version mismatches the version that was used to compile PyTorch (10.2). Please make sure to use the same CUDA versions.`
**Solution**:
```
pip install torch==1.12.1+cu113 torchvision==0.13.1+cu113 -f https://download.pytorch.org/whl/torch_stable.html
```
* [Installation errors, File "setup.py" not found](pip-install-error)
- [Installation errors, File "setup.py" not found](pip-install-error)
(pip-install-error)=
#### Installation errors, File "setup.py" not found
When installing dependencies and nerfactory with `pip install -e .`, you run into: `ERROR: File "setup.py" not found. Directory cannot be installed in editable mode`
**Solution**:
This can be fixed by upgrading pip to the latest version:
```
python -m pip install --upgrade pip
```