Skip to content

Update installation.rst #122

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.

Sign up for GitHub

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

Merged
aylward merged 1 commit into from
Aug 20, 2026
Merged

Update installation.rst #122

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,19 @@ Installation Methods
Method 1: Install from PyPI (Recommended)
------------------------------------------

Install the ``[cuda13]`` extra. It enables every feature and gives the best
Install the ``[all]`` extra. It enables every feature and gives the best
performance:

.. code-block:: bash

uv pip install "physiotwin4d[cuda13]"
uv pip install "physiotwin4d[all]"

The ``[cuda13]`` extra installs CuPy. In uv-managed source environments,
PyTorch, torchvision, and torchaudio resolve from the CUDA 13.0 PyTorch wheel
index. There is no need to install PyTorch separately.
The ``[all]`` extra installs PhysicsNeMo, CuPy, and dependencies for
development, testing, and documenting. In uv-managed source environments,
PyTorch, torchvision, and torchaudio should resolve from the CUDA 13.0 PyTorch wheel
index. However, that automation is not garaunteed for every platform, and it is recommended
to pre-install torch with CUDA acceleration, e.g., as described at
https://pytorch.org/get-started/locally/.

CPU-only fallback (evaluation, or no NVIDIA GPU available):

Expand Down
Loading