diff --git a/README.md b/README.md index 6e9cd8d..667742e 100644 --- a/README.md +++ b/README.md @@ -60,30 +60,24 @@ The optimizer uses PyTorch and CUDA extensions in a Python environment to produc - CUDA-ready GPU with Compute Capability 7.0+ - 24 GB VRAM to train the largest scenes in our test suite +### Software Requirements +- C++ Compiler (Visual Studio 2019 for Windows) +- CUDA 11 Developer SDK +- Conda (recommended for easy setup) + ### Setup -Our provided install method is based on Conda package and environment management. We suggest 3 options, depending on your available disk space. - -#### Option 1 (Plenty of space on system drive) - -To produce our exact evaluation environment on a freshly set up machine should be straightforward once Conda is installed (at the expense of considerable disk space): +Our provided install method is based on Conda package and environment management: ```shell -conda env create --file environment_full.yml # This will take some time +conda env create --file environment.yml # This will take less time conda activate gaussian_splatting ``` -#### Option 2 (Little space on system drive) -If you already have a recent C++ compiler and a version of the CUDA **development** kit 11 installed, you can opt to use the lighter-weight environment install instead. -```shell -conda env create --file environment_light.yml # This will take less time -conda activate gaussian_splatting -``` -#### Option 3 (Even less space on system drive) -Note that even with the light version, downloading packages and creating a new environment with Conda can require a significant amount of disk space. By default, Conda will use the main system hard drive. You can avoid this by specifying a different package download location and an environment on a different drive: +Note that downloading packages and creating a new environment with Conda can require a significant amount of disk space. By default, Conda will use the main system hard drive. You can avoid this by specifying a different package download location and an environment on a different drive: ```shell conda config --add pkgs_dirs / -conda env create --file environment_light.yml --prefix //gaussian_splatting +conda env create --file environment.yml --prefix //gaussian_splatting conda activate //gaussian_splatting ``` @@ -126,9 +120,14 @@ The Network Viewer can be used to observe the training process and watch the mod - OpenGL 4.5-ready GPU - 8 GB VRAM +### Software Requirements +- C++ Compiler (Visual Studio 2019 for Windows) +- CUDA 11 Developer SDK +- CMake (recent version) + ### Setup -If you cloned with submodules (e.g., using ```--recursive```), the source code for the viewers is found in ```SIBR_viewers_(windows|linux)``` (choose whichever fits your OS). The network viewer runs within the SIBR framework for Image-based Rendering applications. For setup, you will need the CUDA 11 **development** kit, a C++ compiler (use Visual Studio **2019** on Windows) and **CMake**, then follow the steps corresponding to your operating system. +If you cloned with submodules (e.g., using ```--recursive```), the source code for the viewers is found in ```SIBR_viewers_(windows|linux)``` (choose whichever fits your OS). The network viewer runs within the SIBR framework for Image-based Rendering applications. #### Windows On Windows, CMake should take care of your dependencies @@ -173,6 +172,11 @@ The Real-Time Viewer can be used to render trained models with real-time frame r - OpenGL 4.5-ready GPU - 8 GB VRAM +### Software Requirements +- C++ Compiler (Visual Studio 2019 for Windows) +- CUDA 11 Developer SDK +- CMake (recent version) + ### Setup The setup is the same as for the remote viewer. diff --git a/environment_light.yml b/environment.yml similarity index 100% rename from environment_light.yml rename to environment.yml diff --git a/environment_full.yml b/environment_full.yml deleted file mode 100644 index 87e8dd8..0000000 --- a/environment_full.yml +++ /dev/null @@ -1,19 +0,0 @@ -name: gaussian_splatting -channels: - - pytorch - - conda-forge - - defaults -dependencies: - - cudatoolkit=11.6 - - cudatoolkit-dev=11.6 - - cxx-compiler=1.3.0 - - plyfile=0.8.1 - - python=3.7.13 - - pip=22.3.1 - - pytorch=1.12.1 - - torchaudio=0.12.1 - - torchvision=0.13.1 - - tqdm - - pip: - - submodules/diff-gaussian-rasterization - - submodules/simple-knn \ No newline at end of file