Skip to content

Commit c586645

Browse files
Kashu7100YilingQiao
authored andcommitted
[MISC] Update documentation. (Genesis-Embodied-AI#1520)
1 parent c9f314d commit c586645

File tree

6 files changed

+315
-52
lines changed

6 files changed

+315
-52
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
# Genesis
1919

2020
## 🔥 News
21+
- [2025-08-05] Released v0.3.0 🎊 🎉
2122
- [2025-07-02] The development of Genesis is now officially supported by [Genesis AI](https://genesis-ai.company/).
2223
- [2025-01-09] We released a [detailed performance benchmarking and comparison report](https://github.com/zhouxian/genesis-speed-benchmark) on Genesis, together with all the test scripts.
2324
- [2025-01-08] Released v0.2.1 🎊 🎉
@@ -68,7 +69,6 @@ Project Page: <https://genesis-embodied-ai.github.io/>
6869
- **Compatibility with various robots**: Robotic arms, legged robots, drones, *soft robots*, and support for loading `MJCF (.xml)`, `URDF`, `.obj`, `.glb`, `.ply`, `.stl`, and more.
6970
- **Photo-realistic rendering**: Native ray-tracing-based rendering.
7071
- **Differentiability**: Genesis is designed to be fully differentiable. Currently, our MPM solver and Tool Solver support differentiability, with other solvers planned for future versions (starting with rigid & articulated body solver).
71-
- **Physics-based tactile simulation**: Differentiable [tactile sensor simulation](https://github.com/Genesis-Embodied-AI/DiffTactile) coming soon (expected in version 0.3.0).
7272
- **User-friendliness**: Designed for simplicity, with intuitive installation and APIs.
7373

7474
## Quick Installation

README_CN.md

Lines changed: 62 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,16 @@
1717

1818
# Genesis 通用物理引擎
1919

20+
## 🔥 最新消息
21+
22+
- [2025-08-05] 发布 v0.3.0 🎊 🎉
23+
- [2025-07-02] Genesis 的开发工作现已获得 [Genesis AI](https://genesis-ai.company/) 的官方支持。
24+
- [2025-01-09] 我们发布了一份关于 Genesis 的[详细性能基准测试和比较报告](https://github.com/zhouxian/genesis-speed-benchmark),并附上所有测试脚本。
25+
- [2025-01-08] 发布 v0.2.1 🎊 🎉
26+
- [2025-01-08] 创建了 [Discord](https://discord.gg/nukCuhB47p)[微信](https://drive.google.com/uc?export=view&id=1ZS9nnbQ-t1IwkzJlENBYqYIIOOZhXuBZ) 社区群。
27+
- [2024-12-25] 添加了支持光线追踪渲染器的 [docker](https://www.google.com/search?q=%23docker)
28+
- [2024-12-24] 添加了[为 Genesis 做贡献](https://github.com/Genesis-Embodied-AI/Genesis/blob/main/.github/CONTRIBUTING.md)的指南。
29+
2030
## 目录
2131

2232
1. [概述](#概述)
@@ -54,31 +64,47 @@ Genesis 是专为 *机器人/嵌入式 AI/物理 AI* 应用设计的通用物理
5464
- **支持广泛的机器人**:机器人手臂、腿式机器人、无人机、*软体机器人*等,并广泛支持加载不同文件类型:`MJCF (.xml)``URDF``.obj``.glb``.ply``.stl` 等。
5565
- **照片级真实感和高性能光线追踪器**:Genesis 支持基于光线追踪的原生渲染。
5666
- **可微分性**:Genesis 设计为完全兼容可微分模拟。目前,我们的 MPM 求解器和工具求解器是可微分的,其他求解器的可微分性将很快添加(从刚体模拟开始)。
57-
- **基于物理的触觉传感器**:Genesis 包含一个基于物理的可微分 [触觉传感器模拟模块](https://github.com/Genesis-Embodied-AI/DiffTactile)。这将很快集成到公共版本中(预计在 0.3.0 版本中)。
5867
- **用户友好性**:Genesis 设计为尽可能简化模拟的使用。从安装到 API 设计,如果有任何您觉得不直观或难以使用的地方,请 [告诉我们](https://github.com/Genesis-Embodied-AI/Genesis/issues)
5968

60-
## 快速入门
6169

62-
### 安装
63-
首先按照[官方指南](https://pytorch.org/get-started/locally/)安装 PyTorch。
70+
## 快速安装
71+
72+
首先,请根据[官方指南](https://pytorch.org/get-started/locally/)安装 **PyTorch**
73+
74+
然后,通过 PyPI 安装 Genesis:
6475

65-
然后可通过 PyPI 安装Genesis:
6676
```bash
67-
pip install genesis-world # 需要 Python >=3.9
77+
pip install genesis-world # 要求 Python>=3.10,<3.14;
6878
```
6979

70-
### Docker 支持
80+
要安装最新的版本,请先通过 `pip install --upgrade pip` 命令确保 `pip` 是最新版本,然后运行以下命令:
7181

72-
如果您想通过 Docker 使用 Genesis,您可以首先构建 Docker 镜像,命令如下:
82+
```bash
83+
pip install git+https://github.com/Genesis-Embodied-AI/Genesis.git
84+
```
85+
86+
请注意,您仍需手动更新此软件包以与主分支保持同步。
87+
88+
如果用户希望编辑 Genesis 的源代码,我们鼓励以可编辑模式安装。首先,请确保已卸载 `genesis-world`,然后克隆代码仓库并在本地安装:
89+
90+
```bash
91+
git clone https://github.com/Genesis-Embodied-AI/Genesis.git
92+
cd Genesis
93+
pip install -e ".[dev]"
94+
```
95+
96+
## Docker
97+
98+
如果您希望通过 Docker 使用 Genesis,可以先像这样构建 Docker 镜像:
7399

74100
```bash
75101
docker build -t genesis -f docker/Dockerfile docker
76102
```
77103

78-
然后,您可以在 Docker 镜像内运行示例代码(挂载到 `/workspace/examples`):
104+
然后您可以在 Docker 镜像中运行示例(示例文件挂载于 `/workspace/examples`):
79105

80106
```bash
81-
xhost +local:root # 允许容器访问显示器
107+
xhost +local:root # 允许容器访问显示设备
82108

83109
docker run --gpus all --rm -it \
84110
-e DISPLAY=$DISPLAY \
@@ -88,6 +114,32 @@ docker run --gpus all --rm -it \
88114
genesis
89115
```
90116

117+
### AMD 用户
118+
119+
AMD 用户可以使用 `docker/Dockerfile.amdgpu` 文件来使用 Genesis,该文件可通过运行以下命令构建:
120+
121+
```
122+
docker build -t genesis-amd -f docker/Dockerfile.amdgpu docker
123+
```
124+
125+
然后通过运行以下命令来使用:
126+
127+
```xhost +local:docker \
128+
docker run -it --network=host \
129+
--device=/dev/kfd \
130+
--device=/dev/dri \
131+
--group-add=video \
132+
--ipc=host \
133+
--cap-add=SYS_PTRACE \
134+
--security-opt seccomp=unconfined \
135+
--shm-size 8G \
136+
-v $PWD:/workspace \
137+
-e DISPLAY=$DISPLAY \
138+
genesis-amd
139+
```
140+
141+
示例文件将可以在 `/workspace/examples` 目录下找到。注意:AMD 用户应使用 Vulkan 后端。这意味着您需要调用 `gs.init(vulkan)` 来初始化 Genesis。
142+
91143
### 文档
92144

93145
- [英文文档](https://genesis-world.readthedocs.io/en/latest/user_guide/index.html)

README_FR.md

Lines changed: 42 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,13 @@
1919

2020
## 🔥 Nouveautés
2121

22-
- [2024-12-25] Ajout d’un [docker](#docker) incluant la prise en charge du moteur de rendu par ray-tracing.
23-
- [2024-12-24] Ajout de directives pour [contribuer à Genesis](https://github.com/Genesis-Embodied-AI/Genesis/blob/main/.github/CONTRIBUTING.md).
22+
- [2025-08-05] Sortie de la v0.3.0 🎊 🎉
23+
- [2025-07-02] Le développement de Genesis est désormais officiellement soutenu par [Genesis AI](https://genesis-ai.company/).
24+
- [2025-01-09] Nous avons publié un [rapport détaillé d'analyse comparative des performances](https://github.com/zhouxian/genesis-speed-benchmark) de Genesis, accompagné de tous les scripts de test.
25+
- [2025-01-08] Sortie de la v0.2.1 🎊 🎉
26+
- [2025-01-08] Création des groupes [Discord](https://discord.gg/nukCuhB47p) et [Wechat](https://drive.google.com/uc?export=view&id=1ZS9nnbQ-t1IwkzJlENBYqYIIOOZhXuBZ).
27+
- [2024-12-25] Ajout d’un [docker](https://www.google.com/search?q=%23docker) incluant la prise en charge du moteur de rendu par lancer de rayon (ray-tracing).
28+
- [2024-12-24] Ajout de directives pour [contribuer à Genesis](https://github.com/Genesis-Embodied-AI/Genesis/blob/main/.github/CONTRIBUTING.md).
2429

2530
## Table des Matières
2631

@@ -61,26 +66,28 @@ Page du projet : <https://genesis-embodied-ai.github.io/>
6166
- **Compatibilité avec divers robots** : Bras robotiques, robots à pattes, drones, *robots mous*, et support pour charger `MJCF (.xml)`, `URDF`, `.obj`, `.glb`, `.ply`, `.stl`, et plus encore.
6267
- **Rendu photo-réaliste** : Rendu natif basé sur le lancer de rayons.
6368
- **Différentiabilité** : Genesis est conçu pour être entièrement différentiable. Actuellement, notre solveur MPM et Tool Solver prennent en charge la différentiabilité, avec d'autres solveurs prévus dans les prochaines versions (à commencer par le solveur de corps rigides et articulés).
64-
- **Simulation tactile basée sur la physique** : Simulation de capteur tactile différentiable [en cours de développement](https://github.com/Genesis-Embodied-AI/DiffTactile) (prévue pour la version 0.3.0).
6569
- **Facilité d'utilisation** : Conçu pour être simple, avec une installation intuitive et des API conviviales.
6670

6771
## Installation Rapide
6872

69-
Genesis est disponible via PyPI :
73+
Installez d'abord **PyTorch** en suivant les [instructions officielles](https://pytorch.org/get-started/locally/).
74+
75+
Ensuite, installez Genesis via PyPI :
7076

7177
```bash
7278
pip install genesis-world # Nécessite Python>=3.10,<3.14;
7379
```
7480

75-
Vous devez également installer **PyTorch** en suivant [les instructions officielles](https://pytorch.org/get-started/locally/).
81+
Pour obtenir la version la plus récente, assurez-vous que `pip` est à jour via `pip install --upgrade pip`, puis exécutez la commande :
7682

77-
Pour la dernière version disponible à ce jour, assurez-vous que `pip` is à jour via `pip install --upgrade pip`, puis executez la commande:
7883
```bash
7984
pip install git+https://github.com/Genesis-Embodied-AI/Genesis.git
8085
```
81-
A noter que le module doit malgré tout être mis à jour manuellement pour rester synchroniser avec la branche principale.
8286

83-
Les utilisateur souhaitant éditer le code source de Genesis sont encouragés à l'installer en mode developpeur/éditable. Assurez vous que `genesis-world` est bien désinstallée, puis clonez le dépôt et installez localement :
87+
Notez que le paquet doit toujours être mis à jour manuellement pour se synchroniser avec la branche principale (main).
88+
89+
Les utilisateurs souhaitant modifier le code source de Genesis sont encouragés à l'installer en mode éditable. D'abord, assurez-vous que `genesis-world` a été désinstallé, puis clonez le dépôt et installez-le localement :
90+
8491
```bash
8592
git clone https://github.com/Genesis-Embodied-AI/Genesis.git
8693
cd Genesis
@@ -89,13 +96,13 @@ pip install -e ".[dev]"
8996

9097
## Docker
9198

92-
Si vous souhaitez utiliser Genesis avec Docker, vous pouvez d'abord construire l'image Docker comme suit :
99+
Si vous souhaitez utiliser Genesis depuis Docker, vous pouvez d'abord construire l'image Docker comme suit :
93100

94101
```bash
95102
docker build -t genesis -f docker/Dockerfile docker
96103
```
97104

98-
Ensuite, vous pouvez exécuter les exemples à l'intérieur de l'image Docker (montés sur `/workspace/examples`) :
105+
Vous pouvez ensuite exécuter les exemples à l'intérieur de l'image Docker (montés dans `/workspace/examples`) :
99106

100107
```bash
101108
xhost +local:root # Autoriser le conteneur à accéder à l'affichage
@@ -106,9 +113,34 @@ docker run --gpus all --rm -it \
106113
-v /tmp/.X11-unix/:/tmp/.X11-unix \
107114
-v $PWD:/workspace \
108115
genesis
116+
```
117+
118+
### Utilisateurs AMD
109119

120+
Les utilisateurs AMD peuvent utiliser Genesis avec le fichier `docker/Dockerfile.amdgpu`, qui se construit en exécutant :
121+
122+
```
123+
docker build -t genesis-amd -f docker/Dockerfile.amdgpu docker
110124
```
111125

126+
et peut ensuite être utilisé en exécutant :
127+
128+
```xhost +local:docker \
129+
docker run -it --network=host \
130+
--device=/dev/kfd \
131+
--device=/dev/dri \
132+
--group-add=video \
133+
--ipc=host \
134+
--cap-add=SYS_PTRACE \
135+
--security-opt seccomp=unconfined \
136+
--shm-size 8G \
137+
-v $PWD:/workspace \
138+
-e DISPLAY=$DISPLAY \
139+
genesis-amd
140+
```
141+
142+
Les exemples seront accessibles depuis `/workspace/examples`. Note : Les utilisateurs AMD doivent utiliser le backend Vulkan. Cela signifie que vous devrez appeler `gs.init(vulkan)` pour initialiser Genesis.
143+
112144
## Documentation
113145

114146
Une documentation complète est disponible en [Anglais](https://genesis-world.readthedocs.io/en/latest/user_guide/index.html) et en [Chinois](https://genesis-world.readthedocs.io/zh-cn/latest/user_guide/index.html). Cela inclut des étapes d'installation détaillées, des tutoriels et des références API.

README_JA.md

Lines changed: 44 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,13 @@
1919

2020
## 🔥 最新情報
2121

22-
- [2024-12-25] [レイトレーシングレンダラー](#docker)をサポートするDockerを追加しました。
23-
- [2024-12-24] [Genesisへの貢献方法](https://github.com/Genesis-Embodied-AI/Genesis/blob/main/.github/CONTRIBUTING.md)に関するガイドラインを追加しました。
22+
- [2025-08-05] v0.3.0をリリースしました 🎊 🎉
23+
- [2025-07-02] Genesisの開発が、[Genesis AI](https://genesis-ai.company/)によって公式にサポートされることになりました。
24+
- [2025-01-09] Genesisに関する[詳細なパフォーマンスベンチマークと比較レポート](https://github.com/zhouxian/genesis-speed-benchmark)を、すべてのテストスクリプトと共に公開しました。
25+
- [2025-01-08] v0.2.1をリリースしました 🎊 🎉
26+
- [2025-01-08] [Discord](https://discord.gg/nukCuhB47p)[Wechat](https://drive.google.com/uc?export=view&id=1ZS9nnbQ-t1IwkzJlENBYqYIIOOZhXuBZ)のグループを作成しました。
27+
- [2024-12-25] レイトレーシングレンダラーをサポートする[docker](https://www.google.com/search?q=%23docker)を追加しました。
28+
- [2024-12-24] [Genesisへの貢献](https://github.com/Genesis-Embodied-AI/Genesis/blob/main/.github/CONTRIBUTING.md)に関するガイドラインを追加しました。
2429

2530
## 目次
2631

@@ -61,28 +66,27 @@ Genesisの目指すところ:
6166
- **様々なロボットへの対応**: ロボットアーム、脚付きロボット、ドローン、*ソフトロボット*など。また、`MJCF (.xml)``URDF``.obj``.glb``.ply``.stl`などの形式をサポート。
6267
- **フォトリアルなレンダリング**: レイトレーシングベースのレンダリングをネイティブでサポート。
6368
- **微分可能性**: 完全な微分可能性を備えた設計。現時点では、MPMソルバーとツールソルバーが対応しており、将来的には他のソルバーも対応予定(まず剛体および連結体ソルバーから開始)。
64-
- **物理ベースの触覚シミュレーション**: 微分可能な[触覚センサーシミュレーション](https://github.com/Genesis-Embodied-AI/DiffTactile)が近日公開予定(バージョン0.3.0を予定)。
6569
- **ユーザーフレンドリー**: シンプルで直感的なインストールとAPI設計。
6670

6771
## インストール
6872

69-
GenesisはPyPIで利用可能です:
73+
まず[公式の手順](https://pytorch.org/get-started/locally/)に従って**PyTorch**をインストールしてください。
74+
75+
次に、PyPI経由でGenesisをインストールします:
7076

7177
```bash
72-
pip install genesis-world # Python>=3.10,<3.14 が必要です;
78+
pip install genesis-world # Python>=3.10,<3.14が必要です;
7379
```
7480

75-
また、**PyTorch**[公式手順](https://pytorch.org/get-started/locally/)に従ってインストールする必要があります。
76-
77-
最新版を利用する場合はこのレポジトリから直接インストールしてください:
81+
最新バージョンを利用するには、`pip install --upgrade pip``pip`を更新してから、次のコマンドを実行してください:
7882

7983
```bash
8084
pip install git+https://github.com/Genesis-Embodied-AI/Genesis.git
8185
```
8286

83-
このパッケージは定期的に手動で最新版と同期する必要があることに注意してください
87+
注意:mainブランチと同期するには、パッケージを手動で更新する必要があります
8488

85-
ソースコードを変更したいユーザはGenesisを開発者モードでインストールすることを推奨します。まず、pip経由の `genesis-world` がアンインストールされていることを確認してください。そして、このレポジトリーを以下のようにクローンしてインストールしてください。
89+
Genesisのソースコードを編集したいユーザーは、編集可能モードでGenesisをインストールすることを推奨します。まず、`genesis-world`がアンインストールされていることを確認し、リポジトリをクローンしてローカルにインストールします:
8690

8791
```bash
8892
git clone https://github.com/Genesis-Embodied-AI/Genesis.git
@@ -92,16 +96,16 @@ pip install -e ".[dev]"
9296

9397
## Docker
9498

95-
DockerからGenesisを利用する場合は、まずDockerイメージをビルドします
99+
DockerからGenesisを使用したい場合は、まず次のようにしてDockerイメージをビルドできます
96100

97101
```bash
98102
docker build -t genesis -f docker/Dockerfile docker
99103
```
100104

101-
その後、Dockerイメージ内で例を実行できます`/workspace/examples`にマウント):
105+
その後、Dockerイメージ内でサンプルを実行できます`/workspace/examples`にマウントされます):
102106

103107
```bash
104-
xhost +local:root # コンテナがディスプレイにアクセスできるようにする
108+
xhost +local:root # コンテナがディスプレイにアクセスすることを許可
105109

106110
docker run --gpus all --rm -it \
107111
-e DISPLAY=$DISPLAY \
@@ -111,6 +115,33 @@ docker run --gpus all --rm -it \
111115
genesis
112116
```
113117

118+
### AMDユーザー
119+
120+
AMDユーザーは、`docker/Dockerfile.amdgpu`ファイルを使ってGenesisを利用できます。これは次のコマンドを実行してビルドします:
121+
122+
```
123+
docker build -t genesis-amd -f docker/Dockerfile.amdgpu docker
124+
```
125+
126+
ビルド後、次のコマンドを実行して使用できます:
127+
128+
```
129+
xhost +local:docker \
130+
docker run -it --network=host \
131+
--device=/dev/kfd \
132+
--device=/dev/dri \
133+
--group-add=video \
134+
--ipc=host \
135+
--cap-add=SYS_PTRACE \
136+
--security-opt seccomp=unconfined \
137+
--shm-size 8G \
138+
-v $PWD:/workspace \
139+
-e DISPLAY=$DISPLAY \
140+
genesis-amd
141+
```
142+
143+
サンプルは`/workspace/examples`からアクセス可能です。注意:AMDユーザーはVulkanバックエンドを使用してください。これは、Genesisを初期化するために`gs.init(vulkan)`を呼び出す必要があることを意味します。
144+
114145
## ドキュメント
115146

116147
包括的なドキュメントは現時点では[英語](https://genesis-world.readthedocs.io/en/latest/user_guide/index.html)[中国語](https://genesis-world.readthedocs.io/zh-cn/latest/user_guide/index.html)、および[日本語](https://genesis-world.readthedocs.io/ja/latest/user_guide/index.html)で提供されています。詳細なインストール手順、チュートリアル、APIリファレンスが含まれています。

0 commit comments

Comments
 (0)