Skip to content

Commit 11711b7

Browse files
committed
install docs
Signed-off-by: Francis Williams <francis@fwilliams.info>
1 parent 392c32b commit 11711b7

File tree

2 files changed

+70
-0
lines changed

2 files changed

+70
-0
lines changed

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ spatial intelligence research and applications.
6868
:hidden:
6969

7070
self
71+
installation
7172

7273
.. toctree::
7374
:maxdepth: 1

docs/installation.rst

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
Installing fVDB
2+
================================================================
3+
4+
fVDB depends on `PyTorch <https://pytorch.org/>`_,
5+
and requires a CUDA-capable GPU. Below are the supported sofware and hardware configurations.
6+
7+
Software Requirements
8+
------------------------
9+
10+
fVDB is currently supported on the matrix of dependencies in the following table.
11+
12+
+------------------+-----------------+-----------------+----------------+------------------------------------------+
13+
| Operating System | PyTorch Version | Python Version | CUDA Version | Vulkan Version (only for visualization) |
14+
+------------------+-----------------+-----------------+----------------+------------------------------------------+
15+
| Linux Only | 2.9.0 | 3.10 - 3.13 | 12.8 - 13.0 | 1.3.275.0 |
16+
+------------------+-----------------+-----------------+----------------+------------------------------------------+
17+
18+
Driver and Hardware Requirements
19+
-----------------------------------
20+
21+
The following table specifies the minimum NVIDIA driver versions and GPU architectures needed to run fVDB-Reality-Capture:
22+
23+
+------------------+----------------+------------------+---------------------+
24+
| Operating System | Driver Version | GPU Architecture | Comptue Capability |
25+
+------------------+----------------+------------------+---------------------+
26+
| Linux Only | 550.0 or later | Ampere or later | 8.0 or greater |
27+
+------------------+----------------+------------------+---------------------+
28+
29+
30+
Installation from pre-built wheels
31+
-------------------------------------
32+
To get started, run the appropriate pip install command for your Pytorch/CUDA versions. This command will install
33+
the correct version of `fvdb-core` if it is not already installed.
34+
35+
36+
PyTorch 2.9.0 + CUDA 12.8
37+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
38+
39+
.. code-block:: bash
40+
41+
pip install fvdb-reality-capture fvdb-core==0.3.0+pt29.cu128 --extra-index-url="https://d36m13axqqhiit.cloudfront.net/simple" torch==2.9.0 --extra-index-url https://download.pytorch.org/whl/cu128
42+
43+
44+
PyTorch 2.9.0 + CUDA 13.0
45+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
46+
47+
.. code-block:: bash
48+
49+
pip install fvdb-reality-capture fvdb-core==0.3.0+pt29.cu130 --extra-index-url="https://d36m13axqqhiit.cloudfront.net/simple" torch==2.9.0 --extra-index-url https://download.pytorch.org/whl/cu130
50+
51+
52+
53+
54+
Installation from source
55+
-----------------------------
56+
57+
Clone the [fvdb-core repository](https://github.com/openvdb/fvdb-core).
58+
59+
.. code-block:: bash
60+
61+
git clone git@github.com:openvdb/fvdb-core.git
62+
63+
Next build and install the fVDB library
64+
65+
.. code-block:: bash
66+
67+
pushd fvdb-core
68+
./build.sh install verbose editor_force
69+
popd

0 commit comments

Comments
 (0)