Improve installation guide and deduplicate gensim install docs#293
Merged
Conversation
Improve install.md with setup paths, package indexes, Docker and verification steps, and troubleshooting. Deduplicate gensim install commands in simready_pipeline.md via cross-link. Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This documentation-only PR reorganizes the installation quick-start into a clearer “choose your path” guide (Docker vs local), centralizes package index guidance, and removes duplicated gensim install blocks from the SimReady pipeline doc by linking to the canonical installation section.
Changes:
- Reworked
install.mdto include setup-path selection, explicit package index variables, expanded Docker/local steps, verification, troubleshooting, and next steps. - Deduplicated SimReady prerequisite install instructions by linking to the
gensimextra section in the install guide.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| docs/source/quick_start/install.md | Restructured installation guide (paths, indexes, Docker/local steps, verification, troubleshooting). |
| docs/source/features/generative_sim/simready_pipeline.md | Replaced repeated gensim install blocks with a link to the canonical install section; minor wording cleanup. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # Installation | ||
|
|
||
| ## System Requirements | ||
| EmbodiChain is a Python framework built on the [DexSim](https://github.com/DexForce) simulation engine (`dexsim_engine` on PyPI). This guide covers system requirements, package indexes, Docker and local install paths, optional generative-simulation dependencies, and verification. |
Comment on lines
+50
to
+53
| > [!TIP] | ||
| > To avoid repeating flags, you can configure pip once: | ||
| > `pip config set global.extra-index-url "${DEXFORCE_INDEX}"` and | ||
| > `pip config set global.trusted-host "${DEXFORCE_TRUSTED_HOST}"`. |
| **With pip:** | ||
|
|
||
| ```bash | ||
| python3.11 -m venv .venv |
Comment on lines
+128
to
+129
| | PyPI | uv | `uv pip install embodichain ${PIP_EXTRA_ARGS}` | | ||
| | PyPI | pip | `pip install embodichain ${PIP_EXTRA_ARGS}` | |
| ``` | ||
|
|
||
| **Install from PyPI with `pip`:** | ||
| **Example — install from PyPI with pip:** |
Comment on lines
+160
to
+161
| | PyPI | uv | `uv pip install "embodichain[gensim]" ${GENSIM_EXTRA_ARGS}` | | ||
| | PyPI | pip | `pip install "embodichain[gensim]" ${GENSIM_EXTRA_ARGS}` | |
| ``` | ||
|
|
||
| Set the OpenAI-compatible LLM api(OpenAI, Gemini, Doubao, etc.) before running the pipeline, or configure them in `embodichain/gen_sim/simready_pipeline/configs/gen_config.json`. Environment variables override the JSON config. | ||
| Set the OpenAI-compatible LLM API (OpenAI, Gemini, Doubao, etc.) before running the pipeline, or configure them in `embodichain/gen_sim/simready_pipeline/configs/gen_config.json`. Environment variables override the JSON config. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR restructures the quick-start installation guide and removes duplicated
gensiminstall commands from the SimReady pipeline doc.Summary of changes:
docs/source/quick_start/install.mdwith a setup-path overview, package index reference, expanded Docker/local install flows, tiered verification, troubleshooting, and next stepsMotivation: The previous install page repeated index URLs and install commands, lacked Docker/verification detail for new users, and duplicated
gensiminstructions already needed elsewhere.Dependencies: None
Type of change
Screenshots
N/A
Checklist
black .command to format the code base. (docs-only change; no Python files modified)Made with Cursor