diff --git a/README.md b/README.md index 76f5b3a0..976def3e 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,8 @@ ## Installation + +##### (Recommended) SplaTAM has been tested on python 3.10, CUDA>=11.6. The simplest way to install all dependences is to use [anaconda](https://www.anaconda.com/) and [pip](https://pypi.org/project/pip/) in the following steps: ```bash @@ -74,12 +76,42 @@ conda install pytorch==1.12.1 torchvision==0.13.1 torchaudio==0.12.1 cudatoolkit pip install -r requirements.txt ``` -We also provide a conda environment.yml file : +Alternatively, we also provide a conda environment.yml file : ```bash conda env create -f environment.yml conda activate splatam ``` +#### Docker and Singularity Setup + +We also provide a docker image. We recommend using a venv to run the code inside a docker image: + + +```bash +docker pull nkeetha/splatam:v1 +bash bash_scripts/docker_start.bash +cd /SplaTAM/ +pip install virtualenv --user +mkdir venv +cd venv +virtualenv splatam --system-site-packages +pip install -r venv_requirements.txt +``` + +Setting up a singularity container is similar: +```bash +cd +pip install virtualenv --user +mkdir venv +cd venv +virtualenv splatam --system-site-packages +pip install -r venv_requirements.txt +``` + ## Demo ### Online diff --git a/bash_scripts/start_docker.bash b/bash_scripts/start_docker.bash new file mode 100644 index 00000000..498712a1 --- /dev/null +++ b/bash_scripts/start_docker.bash @@ -0,0 +1,17 @@ +#!/bin/bash + +docker run -it \ + --volume="./:/SplaTAM/" \ + --env="NVIDIA_VISIBLE_DEVICES=all" \ + --env="NVIDIA_DRIVER_CAPABILITIES=all" \ + --net=host \ + --privileged \ + --group-add audio \ + --group-add video \ + --ulimit memlock=-1 \ + --ulimit stack=67108864 \ + --name splatam \ + --gpus all \ + nkeetha/splatam:v1 \ + /bin/bash + diff --git a/venv_requirements.txt b/venv_requirements.txt new file mode 100644 index 00000000..a223b5b2 --- /dev/null +++ b/venv_requirements.txt @@ -0,0 +1,13 @@ +tqdm==4.65.0 +Pillow +imageio +matplotlib +kornia +natsort +pyyaml +wandb +lpips +torchmetrics +cyclonedds +pytorch-msssim +git+https://github.com/JonathonLuiten/diff-gaussian-rasterization-w-depth.git@cb65e4b86bc3bd8ed42174b72a62e8d3a3a71110 \ No newline at end of file