Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
105 commits
Select commit Hold shift + click to select a range
3b308c3
remove DS_Store file and add to gitignore
guru-desh Dec 20, 2024
0aeb08e
Update visualization.md: add a space between raytracing
martin0258 Dec 21, 2024
13e7f2e
Merge pull request #5 from guru-desh/main
Dec 22, 2024
f7092e0
更新两个错误的超链接
xmlcy Dec 22, 2024
0014b46
Merge pull request #15 from xmlcy/main
GengYiran Dec 23, 2024
9f610cd
Update README.md
GengYiran Dec 23, 2024
3d269bd
Merge pull request #14 from martin0258/patch-1
GengYiran Dec 24, 2024
14dd943
Update README.md
GengYiran Dec 25, 2024
bdf5712
Update locomotion.md
zhouxian Dec 25, 2024
266dad3
docs: fix minor spelling errors in diff-sim doc.
CharlesCNorton Dec 27, 2024
74a072c
Update Luisa installation
ACMLCZH Dec 28, 2024
ebe1a2a
Bash tag
ACMLCZH Dec 28, 2024
9244de3
Denoiser Explain
ACMLCZH Dec 28, 2024
43f5158
Merge pull request #17 from CharlesCNorton/patch-1
GengYiran Dec 29, 2024
1dd208d
update installation note
Kashu7100 Dec 29, 2024
f98de4a
Merge branch 'main' of https://github.com/Genesis-Embodied-AI/genesis…
Kashu7100 Dec 29, 2024
04017a0
Update installation.md
zhouxian Dec 29, 2024
7981f12
update Hover env
KafuuChikai Jan 2, 2025
9cc8e21
update hover_env.mp4
KafuuChikai Jan 2, 2025
bc18714
update Hover_env
KafuuChikai Jan 2, 2025
ef2969e
Merge pull request #19 from KafuuChikai/drone_rl
zhouxian Jan 4, 2025
eeb26d6
Update inverse_kinematics_motion_planning.md
zhouxian Jan 5, 2025
277dfca
update index
zswang666 Jan 8, 2025
ce3e573
Fix typo in collision_representation.md
BarisYazici Jan 8, 2025
b45b56a
Merge pull request #24 from BarisYazici/patch-1
zhouxian Jan 8, 2025
52ced07
update hover_env.md
KafuuChikai Jan 17, 2025
f0fbf1d
Merge pull request #26 from KafuuChikai/main
GengYiran Jan 24, 2025
2eb8141
Update conf.py
ACMLCZH Feb 13, 2025
a51ad8a
Update control_your_robot.md
TheOtherRealm Feb 16, 2025
079f981
Merge pull request #31 from TheOtherRealm/patch-1
GengYiran Feb 17, 2025
aad6e2f
Update installation.md
ACMLCZH Mar 17, 2025
d38c32c
Update python version requirement and supported features matrix.
duburcqa Mar 22, 2025
dd2b321
add data indexing
zswang666 Mar 26, 2025
072967a
add config
zswang666 Apr 8, 2025
1971ef6
Update RSL RL requirement.
duburcqa Apr 10, 2025
c3055a7
Update hover_env.md
KafuuChikai Apr 17, 2025
75d73bf
Merge pull request #36 from KafuuChikai/update_drone
duburcqa Apr 17, 2025
e05b8d0
add overview
zswang666 Apr 10, 2025
7d8e84f
add naming
zswang666 May 3, 2025
177ac30
add api doc
zswang666 May 6, 2025
f238587
update concept
zswang666 May 6, 2025
2ce1b3a
hello genesis example
YilingQiao May 7, 2025
1269d00
fix hello genesis example
YilingQiao May 7, 2025
9ad7565
Add gpu rendering slowdown fix (#35)
jadechoghari May 8, 2025
15ecf0b
Add more troubleshooting sections.
duburcqa May 16, 2025
dfb2897
Merge pull request #42 from Genesis-Embodied-AI/troubleshooting
duburcqa May 16, 2025
fd321bc
Fix doc formatting issues.
duburcqa May 21, 2025
0f8d2da
Merge pull request #43 from Genesis-Embodied-AI/troubleshooting
duburcqa May 21, 2025
84e195c
fix citation
Kashu7100 May 27, 2025
dbcef40
Merge pull request #45 from Genesis-Embodied-AI/feat-citation
Kashu7100 May 27, 2025
68ee6e6
update citation box
Kashu7100 May 28, 2025
27cc656
Update LuisaRendering Guide
ACMLCZH May 28, 2025
1948a02
Update visualization.md
ACMLCZH Jun 3, 2025
af27e51
Add documentations about collision, dynamics, constraints (#49)
YilingQiao Jun 15, 2025
646e512
update show_FPS in profiling options (#47)
hughperkins Jun 15, 2025
70cd56f
delete empty pages (#51)
YilingQiao Jun 15, 2025
ceb6347
update default fem damping 45.0 -> 0.0
Milotrince Jun 16, 2025
e60f24b
rename titles (#53)
YilingQiao Jun 17, 2025
2550804
Add troubleshooting note on Taichi not initializing CUDA on WSL
gasnica Jun 18, 2025
db46241
Add troubleshooting note on Taichi not initializing CUDA on WSL
duburcqa Jun 18, 2025
d222287
update USD support
ACMLCZH Jun 20, 2025
a8bca4e
Merge pull request #52 from Milotrince/fix_default_fem_damping
Kashu7100 Jul 4, 2025
7ccfee6
added gjk description
SonSang Jul 8, 2025
a09c365
updated gjk/mpr description
SonSang Jul 9, 2025
650d29d
updated mpr description
SonSang Jul 9, 2025
75fc8e6
modified mpr description
SonSang Jul 9, 2025
e1f7b7b
Merge pull request #58 from SonSang/gjk
duburcqa Jul 9, 2025
166287b
update usd baking EULA
ACMLCZH Jul 16, 2025
c1cf26c
add sensor page (#61)
Milotrince Jul 18, 2025
8eabdcc
Replace tactile_fingertips.mp4 video to stable version (#62)
Milotrince Jul 18, 2025
d098ebb
Update doc for gs-madrona batch renderer (#60)
yuhongyi Jul 30, 2025
5df5aab
Remove 'splashsurf'.
duburcqa Aug 10, 2025
61aa542
Merge pull request #64 from Genesis-Embodied-AI/splashsurf
duburcqa Aug 11, 2025
8d5d491
Update Sensors page with IMU (#65)
Milotrince Aug 22, 2025
13f25a1
use local source (#66)
YilingQiao Aug 22, 2025
64b0bfd
update requirement for gstaichi (#67)
YilingQiao Aug 22, 2025
0787699
add manipulation example with two stage trianing
yun-long Sep 1, 2025
4a06ee2
add images and videos
yun-long Sep 1, 2025
a3b190b
some minor tuning of the documentation
yun-long Sep 1, 2025
69c979f
Merge pull request #68 from yun-long/main
duburcqa Sep 2, 2025
47e0f95
Fix typos. Remove any reference to 'gs clean'. (#69)
duburcqa Sep 17, 2025
b8edc64
add convention chapter (#70)
YilingQiao Sep 17, 2025
619e2b3
Fix missing file.
duburcqa Sep 18, 2025
a07cedb
Merge pull request #72 from Genesis-Embodied-AI/fix_missing_misc
duburcqa Sep 18, 2025
ec1ff64
remove coupler (#73)
YilingQiao Sep 22, 2025
306ba67
Fix a typo in locomotion.md (#74)
ibraEssam Oct 9, 2025
ad7389d
Update documentation (#75)
duburcqa Oct 20, 2025
12e78c3
Fix performance regression in benchmark due to self collision. (#77)
duburcqa Nov 15, 2025
428ce26
update sensors doc page and add recorders page (#76)
Milotrince Nov 25, 2025
176350b
Fix outdated doc. (#81)
duburcqa Dec 2, 2025
f9982b2
Delete source/_static/videos/batched_IK.mp4
GWinfinity Dec 6, 2025
dee9d16
docs(api_reference): 完善实体类文档,添加详细说明和示例代码
GWinfinity Dec 6, 2025
8b7f0a7
docs(rigid_entity): 完善刚体系统文档并移除PBD实体示例代码
GWinfinity Dec 6, 2025
bf53dce
docs(api_reference): 完善多个API参考文档内容并删除hybrid.md
GWinfinity Dec 6, 2025
f69ef51
docs(api_reference): 添加材料类文档的详细说明和参数表格
GWinfinity Dec 6, 2025
09129e5
docs(api): 完善PBD和SPH材料模块的文档内容
GWinfinity Dec 6, 2025
2692fed
docs(api_reference): 为形态类文档添加详细说明和参数表格
GWinfinity Dec 6, 2025
7ffd043
docs(api_reference): 更新渲染器和模拟器选项的文档
GWinfinity Dec 6, 2025
69c74a0
docs: 完善材质文档,添加详细参数说明和使用示例
GWinfinity Dec 6, 2025
b96c8d8
docs(api): 添加纹理相关API的详细中文文档
GWinfinity Dec 6, 2025
0396ac9
docs(api): 添加可视化系统相关文档内容
GWinfinity Dec 6, 2025
92230df
docs(api_reference): 完善场景和力场API文档
GWinfinity Dec 6, 2025
0cdfa23
docs(api_reference): 添加工具实体和烟雾火焰实体文档,更新力场说明
GWinfinity Dec 8, 2025
e09f6f4
docs(api_reference): 添加物理引擎核心组件API文档
GWinfinity Dec 9, 2025
68d4df0
feat: 添加Genesis API参考文档代理工具
GWinfinity Dec 9, 2025
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
Binary file removed .DS_Store
Binary file not shown.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
build
source/user_guide/reference/_autosummary/
source/user_guide/reference/_autosummary/
.DS_Store
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
# Genesis Documentation
# Genesis Documentation (English Version)

1. Create a clean env using python 3.10, install Sphinx and other dependencies
1. Create a clean env using python >= 3.9, install Sphinx and other dependencies

```bash
# In Genesis-dev/
pip install -e ".[docs]"
pip install genesis-world # Requires Python >= 3.9;
```

2. Build the documentation and watch the change lively

```bash
# In doc/
# In genesis-doc/
rm -rf build/; make html; sphinx-autobuild ./source ./build/html
```
```
164 changes: 164 additions & 0 deletions README_AGENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,164 @@
# Genesis API Reference Agent

A powerful Python agent that integrates all API documentation from the `api_reference` directory and provides a convenient interface for users to query and access API information.

## Features

- **Comprehensive Documentation Integration**: Loads and processes all Markdown documentation from the API reference directory
- **Structured Knowledge Base**: Organizes API information into categories (entities, materials, options, scene, sensor)
- **Advanced Search**: Search for APIs by name, description, or parameters
- **Interactive Mode**: User-friendly command-line interface for querying API information
- **Export Functionality**: Export the knowledge base to JSON for external use

## Installation

No external dependencies are required. The agent uses only Python standard libraries.

## Usage

### Basic Usage

Run the agent in interactive mode:

```bash
python genesis_api_agent.py
```

### Interactive Commands

- `help`: Show help information
- `exit`: Exit the agent
- `categories`: List all categories
- `list [category]`: List all APIs (optionally filtered by category)
- `search <query>`: Search for APIs matching query
- `get <api_name>`: Get detailed information about an API
- `<natural language>`: Ask a question about the API (experimental)

### Example Usage

```
=== Genesis API Reference Agent ===
Type 'help' for available commands, 'exit' to quit.
===================================

> categories

Categories:
- entities: 22 APIs
- materials: 23 APIs
- options: 17 APIs
- scene: 5 APIs
- sensor: 1 APIs

> list entities

APIs (22 total):
1. entities.DroneEntity
2. entities.Emitter
3. entities.FEMEntity
4. entities.HybridEntity
5. entities.MPMEntity
6. entities.SFEntity
7. entities.SPHEntity
8. entities.Tool
...

> search force field

Search results for 'force field' (1 total):
1. scene.ForceField (scene)
ForceField 是所有力场的基类,用于在模拟中对物体施加各种类型的力(实际上是加速度场)。

> get ForceField

=== ForceField ===
Category: scene

Summary:
ForceField 是所有力场的基类,用于在模拟中对物体施加各种类型的力(实际上是加速度场)。

Inheritance:
ForceField
├── Constant
├── Wind
├── Point
├── Drag
├── Noise
├── Vortex
├── Turbulence
└── Custom

Parameters:
- direction (Vector): 力场的方向向量,必须是归一化的三维向量
- strength (float): 力场的强度(加速度值,单位:m/s²)
- active (bool): 力场是否激活,默认为True

Code Examples:
Example 1:
```python
import genesis as gs

# 创建场景
scene = gs.Scene()

# 添加一个球体
sphere = gs.primitives.Sphere(position=(0, 0, 1))
scene.add_entity(sphere)

# 创建并添加恒定力场(恒定加速度)
constant_force = gs.force_fields.Constant(direction=(1, 0, 0), strength=5.0)
scene.add_force_field(constant_force)

# 构建并运行场景
scene.build()
for _ in range(100):
scene.step()
```
```

### Programmatic Usage

You can also use the agent programmatically:

```python
from genesis_api_agent import GenesisAPIAgent

# Initialize the agent
agent = GenesisAPIAgent()

# List all categories
categories = agent.knowledge_base.keys()

# Search for APIs
results = agent.search("force field")

# Get detailed API info
api_info = agent.get_api_info("ForceField")

# Export knowledge base to JSON
agent.export_knowledge_base("genesis_api_knowledge_base.json")
```

## Knowledge Base Structure

The agent builds a structured knowledge base with the following information for each API:

- **Title**: API name and title
- **Summary**: Brief description of the API
- **Inheritance**: Class inheritance hierarchy
- **Parameters**: List of parameters with types and descriptions
- **Code Examples**: Usage examples in Python
- **File Path**: Location of the source documentation

## Extending the Agent

You can extend the agent by adding new features:

1. **NLP Integration**: Add natural language processing for better query handling
2. **Web Interface**: Create a web-based UI for the agent
3. **Additional Formats**: Support for exporting to other formats (HTML, PDF)
4. **Live Updates**: Add functionality to update the knowledge base dynamically

## License

This project is open source and available under the MIT License.
Loading