Fix softbody installation instructions in installation.md (#99)

* Fix softbody installation instructions in installation.md * Fix build_lib import issue * Update the doc --------- Co-authored-by: Jiayuan-Gu <[email protected]>
haosulab · May 30, 2023 · 9fc260f · 9fc260f
1 parent 538ab6c
commit 9fc260f
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/docs/source/getting_started/installation.md b/docs/source/getting_started/installation.md
@@ -61,6 +61,8 @@ If `nvcc` is included in `$PATH`, we will try to figure out the variable `CUDA_P
 After CUDA is properly set up, compile Warp customized for ManiSkill2:
 
 ``` bash
+# If you encounter "ModuleNotFoundError: No module named 'warp'", please add warp_maniskill to the python path. 
+export PYTHONPATH=/path/to/ManiSkill2/warp_maniskill:$PYTHONPATH
 # warp.so is generated under warp_maniskill/warp/bin
 python -m warp_maniskill.build_lib
 ```
@@ -169,7 +171,7 @@ The following errors can happen if the Vulkan driver is broken. Try to reinstall
 If the soft-body environment throws a **memory error**, you can try compiling Warp in the debug mode.
 
 ```bash
-python -m warp_maniskill.build_lib --mode debug
+PYTHONPATH="$PWD"/warp_maniskill:$PYTHONPATH python -m warp_maniskill.build_lib --mode debug
 ```
 
 Remember to compile again in the release mode after you finish debugging. In the debug mode, if the error becomes `unsupported toolchain`, it means you have a conflicting CUDA version.

diff --git a/warp_maniskill/build_lib.py b/warp_maniskill/build_lib.py
@@ -9,6 +9,11 @@
 import os
 import argparse
 
+package_dir = os.path.join(os.path.dirname(__file__))
+package_dir = os.path.normpath(package_dir)
+if package_dir not in sys.path:
+    sys.path.append(package_dir)
+
 import warp.config
 import warp.build