mshab

(β˜… 197)

A Benchmark for Low-Level Manipulation in Home Rearrangement Tasks

  • .gitignore
  • .pre-commit-config.yaml
  • pyproject.toml
  • README.md
  • setup.py

# Installation Guide

1. Get the code
git clone https://github.com/arth-shukla/mshab

Downloads the entire project code from GitHub to your computer.

cd mshab

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f docker/Dockerfile -t mshab .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 mshab

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install -e ManiSkill

Installs the Python libraries listed in requirements.txt (or similar).

pip install -e . # NOTE: you can optionally install train and dev dependencies via `pip install -e .[train,dev]`

Installs the Python libraries listed in requirements.txt (or similar).

for dataset in ycb ReplicaCAD ReplicaCADRearrange; do python -m mani_skill.utils.download_asset "$dataset"; done

Runs the Python script (or module).

pip install -e .[train]

Installs the Python libraries listed in requirements.txt (or similar).

pip install -e .[dev]

Installs the Python libraries listed in requirements.txt (or similar).

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation