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

Add Pixi as an option for installation #3130

Merged
merged 10 commits into from
May 19, 2024
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -188,3 +188,6 @@ camera_paths/
*/**/.DS_Store
*/**/._.DS_Store

# pixi environments
.pixi
/third_party
29 changes: 29 additions & 0 deletions docs/quickstart/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,35 @@ pip install -e .[dev]
pip install -e .[docs]
```

## Using Pixi
[Pixi](https://pixi.sh/latest/) is a fast software package manager built on top of the existing conda ecosystem. Spins up development environments quickly on Windows, macOS and Linux. (Currently only linux is supported for nerfstudio)

### Prerequisites
Make sure to have pixi installed, detailed instructions [here](https://pixi.sh/latest/)

TLDR for linux:

```bash
curl -fsSL https://pixi.sh/install.sh | bash
```

### Install Pixi Environmnent
After Pixi is installed, you can run
```bash
pixi run post-install
pixi shell
```
This will install all enviroment dependancies including colmap, tinycudann and hloc, and the active the conda environment

you could also run

```bash
pixi run post-install
pixi run train-example-nerf
```

to download an example dataset and run nerfacto straight away

## Use docker image

Instead of installing and compiling prerequisites, setting up the environment and installing dependencies, a ready to use docker image is provided.
Expand Down