Skip to content

Commit

Permalink
added a manual instruction in the README to run On branch pixi-setup
Browse files Browse the repository at this point in the history
Changes to be committed:
  (use "git restore --staged <file>..." to unstage)
	modified:   README.md

dev_setup.sh
docker
docs
LICENSE
obelisk
obelisk_ws
pixi.lock
pixi.toml
pyrightconfig.json
pytest.ini
README.md
ruff.toml
scripts
tests
dev_setup.sh
docker
docs
LICENSE
obelisk
obelisk_ws
pixi.lock
pixi.toml
pyrightconfig.json
pytest.ini
README.md
ruff.toml
scripts
tests
3laws_amberlab
ambersim
argus
_backup
cache
calibration_data.png
cc_test.py
CSDI
cube_rotation
curobo
drake
drake_playground
DynamixelSDK
example.py
fileback.png
filedown.png
filefront.png
fileleft.png
fileright.png
fileup.png
fr3
frogger
goblet.png
idtx
jaxngp
jaxosqp
jax_simplex
LEAP_Hand_API
mjpc_ros2
ml-agents
mujoco
mujoco_menagerie
mujoco_mpc
nerf_grasping
nerfstudio
nerf_to_mesh.py
obelisk
_old
panda-py
perseus
pfc
pyink
pytorch3d
qwerty_cube_assets.pdf
RCareWorld
rlcbf
rubiks_curvature.png
sdfstudio
sim_script.py
sim_simple_script.py
slides
tapnet
test_grasping
tiny-cuda-nn
torchquad
TorchSDF
torch-template-repo
tsdf_refactor
urdf-viz
vince_ros
vince_ros.zip
dev_setup.sh
docker
docs
LICENSE
obelisk
obelisk_ws
pixi.lock
pixi.toml
pyrightconfig.json
pytest.ini
README.md
ruff.toml
scripts
tests
dev_setup.sh
docker
docs
LICENSE
obelisk
obelisk_ws
pixi.lock
pixi.toml
pyrightconfig.json
pytest.ini
README.md
ruff.toml
scripts
tests
On branch pixi-setup
Changes to be committed:
  (use "git restore --staged <file>..." to unstage)
	modified:   README.md

3laws_amberlab
ambersim
argus
_backup
cache
calibration_data.png
cc_test.py
CSDI
cube_rotation
curobo
drake
drake_playground
DynamixelSDK
example.py
fileback.png
filedown.png
filefront.png
fileleft.png
fileright.png
fileup.png
fr3
frogger
goblet.png
idtx
jaxngp
jaxosqp
jax_simplex
LEAP_Hand_API
mjpc_ros2
ml-agents
mujoco
mujoco_menagerie
mujoco_mpc
nerf_grasping
nerfstudio
nerf_to_mesh.py
obelisk
_old
panda-py
perseus
pfc
pyink
pytorch3d
qwerty_cube_assets.pdf
RCareWorld
rlcbf
rubiks_curvature.png
sdfstudio
sim_script.py
sim_simple_script.py
slides
tapnet
test_grasping
tiny-cuda-nn
torchquad
TorchSDF
torch-template-repo
tsdf_refactor
urdf-viz
vince_ros
vince_ros.zip after the dev_setup.sh script
  • Loading branch information
alberthli committed Jun 20, 2024
1 parent ab40f8b commit cef2565
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ This repository hosts generic interfaces for controlling the lab's robots with R
We recommend developing using `pixi` for dependency management. First, install required system-level dependencies for development and setting environment variables by running the following script:
```
source dev_setup.sh
newgrp docker
```
This will do the following:
1. install `docker`
Expand All @@ -25,6 +26,10 @@ To enter the container without rebuilding or to join from a different terminal w
```
docker compose -f docker/docker-compose.yml run obelisk
```
If you are running on a machine with no Nvidia GPUs, you can instead run
```
docker compose -f docker/docker-compose-no-gpu.yml run --build obelisk
```

### Building Docs
In the repository root, to build the docs locally, run `sphinx-build -M html docs/source/ docs/build/`.

0 comments on commit cef2565

Please sign in to comment.