Skip to content

Update docs for installation from pypi #104

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
yuecideng merged 1 commit into from
Jan 30, 2026
Merged

Update docs for installation from pypi #104

Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
![teaser](assets/imgs/teaser.jpg)

[![License](https://img.shields.io/github/license/DexForce/EmbodiChain)](LICENSE)
[![Website](https://img.shields.io/badge/website-dexforce.com-green?logo=google-chrome&logoColor=white)](https://dexforce.com/embodichain/index.html#/)
[![Website](https://img.shields.io/badge/website-dexforce.com-yellow?logo=google-chrome&logoColor=white)](https://dexforce.com/embodichain/index.html#/)
[![GitHub Pages](https://img.shields.io/badge/GitHub%20Pages-docs-blue?logo=github&logoColor=white)](https://dexforce.github.io/EmbodiChain/introduction.html)
[![Python](https://img.shields.io/badge/python-3.10%20|%203.11-blue.svg)](https://docs.python.org/3/whatsnew/3.10.html)
[![Version](https://img.shields.io/badge/version-0.1.0-blue.svg)](https://github.com/DexForce/EmbodiChain/releases)
[![Version](https://img.shields.io/github/v/release/DexForce/EmbodiChain?label=version)](https://github.com/DexForce/EmbodiChain/releases)
---

EmbodiChain is an end-to-end, GPU-accelerated framework for Embodied AI. It streamlines research and development by unifying high-performance simulation, real-to-sim data pipelines, modular model architectures, and efficient training workflows. This integration enables rapid experimentation, seamless deployment of intelligent agents, and effective Sim2Real transfer for real-world robotic systems.
Expand Down
12 changes: 10 additions & 2 deletions docs/source/quick_start/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,16 @@ After pulling the Docker image, you can run a container with the provided [scrip

> **We strongly recommend using a virtual environment to avoid dependency conflicts.**

Clone the EmbodiChain repository:
To install EmbodiChain from pypi, run:

```bash
pip install embodichain --extra-index-url http://pyp.open3dv.site:2345/simple/ --trusted-host pyp.open3dv.site

# Or install with the lerobot extras:
pip install embodichain[lerobot] --extra-index-url http://pyp.open3dv.site:2345/simple/ --trusted-host pyp.open3dv.site
```

To install the Embodichain from source, clone the EmbodiChain repository:
```bash
git clone https://github.com/DexForce/EmbodiChain.git
```
Expand All @@ -71,4 +80,3 @@ python scripts/tutorials/sim/create_scene.py
python scripts/tutorials/sim/create_scene.py --headless
```
---

Loading