Skip to content

Commit b6a1118

Browse files
authored
Improve documentation for dev install. (#32)
1 parent 44b403a commit b6a1118

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ It is a renderer used in Genesis to provide native support of batched processing
1414

1515
At present, batch rendering supports only basic materials, lighting, and shadows. However, we aim to expand its capabilities to include more advanced rendering features.
1616

17-
While gs-madrona currently relies on Genesis-specific dependencies, we plan to decouple it in the near future to support broader use cases through a more generic interface.
17+
While gs-madrona currently depends on Genesis, we plan to decouple it in the near future to support broader use cases through a more generic interface.
1818

1919
## Features Added Since Fork
2020
- Support for non-square resolutions
@@ -78,12 +78,15 @@ pip install gs-madrona
7878
```
7979

8080
### Build from source
81+
Please first install CUDA toolkit (>= 12.4) following the [official instructions](https://developer.nvidia.com/cuda-toolkit-archive).
8182
```sh
8283
git clone --recurse-submodules https://github.com/Genesis-Embodied-AI/gs-madrona.git
8384
cd gs-madrona
84-
pip install .
85+
pip install --no-build-isolation -Cbuild-dir=build -v -e .
8586
```
8687

88+
Make sure that the version of `torch` installed on your system that has been pre-compiled against a version of CUDA Toolkit that is equal or newer than the one available on your system. Otherwise, gs-madrona will crash at import (segmentation fault). Please follow the [official instructions](https://pytorch.org/get-started/locally/).
89+
8790
### Testing (Optional)
8891
1. Clone Genesis Simulator repository if not already done
8992
```sh

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ ninja.make-fallback = true
3737
wheel.cmake = true
3838
editable.verbose = true
3939
editable.rebuild = false
40+
editable.mode = "redirect"
4041
build.verbose = true
4142
install.strip = false
4243
search.site-packages = true

0 commit comments

Comments
 (0)