From 5420046860482943001ea6d4b3eca2fedded0faf Mon Sep 17 00:00:00 2001 From: "aiyion.prime" Date: Wed, 13 Nov 2024 19:24:54 +0100 Subject: [PATCH] Provide setup instructions --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6e165b0b..6e9ccd82 100644 --- a/README.md +++ b/README.md @@ -16,4 +16,19 @@ Used as the rasterization engine for the paper "3D Gaussian Splatting for Real-T url = {https://repo-sam.inria.fr/fungraph/3d-gaussian-splatting/} } - \ No newline at end of file + + + +## Development setup + +In order to install this package the execution of the setup.py and an existing recent cuda installation at `CUDA_HOME` itself is necessary: + + +```python +python -m venv venv +source venv/bin/activate +pip install torch +CUDA_HOME=/opt/cuda/ python setup.py develop +``` + +For installation only (not in editable mode), swap `develop` for `install`.