# genesis-embodied-ai/genesis architecture

> Architecture diagram of the GitHub repository genesis-embodied-ai/genesis, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/genesis-embodied-ai/genesis
- Repository: https://github.com/genesis-embodied-ai/genesis

## Overview

##### High-Level Architecture Overview

a) Application Layer
- Examples and Tutorials
- User Interface Components
- API Endpoints

b) Core Engine Layer
- Physics Solvers
- Entity Management
- Material Systems
- Scene Management

c) Backend Layer
- Compute Backends (CPU, GPU, Metal)
- Rendering Systems
- File I/O and Asset Management

##### Key Components

a) Physics Solver Components (genesis/engine/solvers/)
- Rigid Body Solver
- MPM Solver
- SPH Solver
- FEM Solver
- PBD Solver
- Tool Solver
Their interactions and data flow.

b) Entity System (genesis/engine/entities/)
- Base Entity
- Avatar Entity
- Rigid Entity
- Particle Entity
- Tool Entity
Inheritance relationships.

c) Material System (genesis/engine/materials/)
- FEM Materials
- MPM Materials
- PBD Materials
- SPH Materials
Material hierarchies and properties.

d) Visualization System (genesis/vis/)
- Rasterizer
- Raytracer
- Viewer Components
Rendering pipeline flow.

##### Specific Implementation Details

a) Coupling between different solvers:
- Coupler.py component
- Demonstrate interaction between rigid bodies and deformable objects
- Fluid-solid coupling paths

b) Differentiation system:
- Grad/ directory components
- Automatic differentiation paths
- Differentiable components

c) Asset Management:
- URDF/MJCF loading pipeline
- Mesh processing flow
- Material property handling

##### External Integrations

Connections to:
- Taichi backend
- LuisaCompute/LuisaRender
- PyRender
- External robot description formats

##### Performance Optimization Paths

Highlight:
- Parallel computation routes
- GPU acceleration paths
- Memory management systems
- Caching mechanisms

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% 스타일 정의
    classDef core fill:#1a365d,color:white,stroke-width:2px
    classDef feature fill:#2f855a,color:white,stroke-width:2px
    classDef util fill:#553c9a,color:white,stroke-width:2px
    classDef solver fill:#2c5282,color:white
    classDef entity fill:#276749,color:white
    classDef material fill:#44337a,color:white
    classDef vis fill:#285e61,color:white

    %% 범례
    subgraph Legend["범례"]
        L1[🔷 핵심 구성요소]:::core
        L2[🔶 기능 모듈]:::feature
        L3[⭐ 유틸리티 모듈]:::util
        L4["→ 데이터 흐름"]
        L5["⇢ 의존성"]
        L6["⇄ 양방향 상호작용"]
    end

    %% 핵심 계층
    subgraph CoreLayer["핵심 계층"]
        Engine["🔷 엔진 코어"]:::core
        Scene["장면 관리"]:::core
        PhysicsSolvers["물리 솔버"]:::core
        EntitySystem["엔티티 시스템"]:::core
        MaterialSystem["재질 시스템"]:::core
    end

    %% 기능 계층
    subgraph FeatureLayer["기능 계층"]
        Vis["🔶 시각화"]:::feature
        DiffComp["🔶 미분 가능 연산"]:::feature
        AssetLoad["🔶 에셋 로딩"]:::feature
        Boundary["🔶 경계 처리"]:::feature
    end

    %% 유틸리티 계층
    subgraph UtilLayer["유틸리티 계층"]
        Logging["⭐ 로깅 시스템"]:::util
        Options["⭐ 옵션 관리"]:::util
        Constants["⭐ 상수 정의"]:::util
        Utils["⭐ 일반 유틸리티"]:::util
    end

    %% 물리 솔버 상세
    subgraph Solvers["물리 솔버 시스템"]
        RigidSolver["🔄 강체 솔버"]:::solver
        MPMSolver["🔄 MPM 솔버"]:::solver
        SPHSolver["🔄 SPH 솔버"]:::solver
        FEMSolver["🔄 FEM 솔버"]:::solver
        PBDSolver["🔄 PBD 솔버"]:::solver
        SFSolver["🔄 SF 솔버"]:::solver
    end

    %% 엔티티 시스템 상세
    subgraph Entities["엔티티 시스템"]
        AvatarEntity["📦 아바타 엔티티"]:::entity
        RigidEntity["📦 강체 엔티티"]:::entity
        ParticleEntity["📦 입자 엔티티"]:::entity
        ToolEntity["📦 도구 엔티티"]:::entity
        HybridEntity["📦 하이브리드 엔티티"]:::entity
    end

    %% 시각화 시스템 상세
    subgraph Visual["시각화 시스템"]
        Rasterizer["🎨 래스터라이저"]:::vis
        Raytracer["🎨 레이트레이서"]:::vis
        Camera["🎨 카메라"]:::vis
        Viewer["🎨 뷰어"]:::vis
        Visualizer["🎨 시각화 도구"]:::vis
    end

    %% 연결 관계
    Engine --> Scene
    Engine --> PhysicsSolvers
    Engine --> EntitySystem
    Engine --> MaterialSystem
    PhysicsSolvers --> Solvers
    EntitySystem --> Entities
    Vis --> Visual
    
    %% 클릭 이벤트
    click Scene "https://github.com/Genesis-Embodied-AI/Genesis/blob/main/genesis/engine/scene.py"
    click PhysicsSolvers "https://github.com/Genesis-Embodied-AI/Genesis/tree/main/genesis/engine/solvers/"
    click EntitySystem "https://github.com/Genesis-Embodied-AI/Genesis/tree/main/genesis/engine/entities/"
    click MaterialSystem "https://github.com/Genesis-Embodied-AI/Genesis/tree/main/genesis/engine/materials/"
    click Vis "https://github.com/Genesis-Embodied-AI/Genesis/tree/main/genesis/vis/"
    click DiffComp "https://github.com/Genesis-Embodied-AI/Genesis/tree/main/genesis/grad/"
    click AssetLoad "https://github.com/Genesis-Embodied-AI/Genesis/blob/main/genesis/engine/mesh.py"
    click Boundary "https://github.com/Genesis-Embodied-AI/Genesis/blob/main/genesis/engine/boundaries/boundaries.py"
    click Logging "https://github.com/Genesis-Embodied-AI/Genesis/tree/main/genesis/logging/"
    click Options "https://github.com/Genesis-Embodied-AI/Genesis/tree/main/genesis/options/"
    click Constants "https://github.com/Genesis-Embodied-AI/Genesis/blob/main/genesis/constants.py"
    click Utils "https://github.com/Genesis-Embodied-AI/Genesis/tree/main/genesis/utils/"
    click RigidSolver "https://github.com/Genesis-Embodied-AI/Genesis/blob/main/genesis/engine/solvers/rigid/rigid_solver.py"
    click MPMSolver "https://github.com/Genesis-Embodied-AI/Genesis/blob/main/genesis/engine/solvers/mpm_solver.py"
    click SPHSolver "https://github.com/Genesis-Embodied-AI/Genesis/blob/main/genesis/engine/solvers/sph_solver.py"
    click FEMSolver "https://github.com/Genesis-Embodied-AI/Genesis/blob/main/genesis/engine/solvers/fem_solver.py"
    click PBDSolver "https://github.com/Genesis-Embodied-AI/Genesis/blob/main/genesis/engine/solvers/pbd_solver.py"
    click SFSolver "https://github.com/Genesis-Embodied-AI/Genesis/blob/main/genesis/engine/solvers/sf_solver.py"
    click AvatarEntity "https://github.com/Genesis-Embodied-AI/Genesis/tree/main/genesis/engine/entities/avatar_entity/"
    click RigidEntity "https://github.com/Genesis-Embodied-AI/Genesis/tree/main/genesis/engine/entities/rigid_entity/"
    click ParticleEntity "https://github.com/Genesis-Embodied-AI/Genesis/blob/main/genesis/engine/entities/particle_entity.py"
    click ToolEntity "https://github.com/Genesis-Embodied-AI/Genesis/tree/main/genesis/engine/entities/tool_entity/"
    click HybridEntity "https://github.com/Genesis-Embodied-AI/Genesis/blob/main/genesis/engine/entities/hybrid_entity.py"
    click Rasterizer "https://github.com/Genesis-Embodied-AI/Genesis/blob/main/genesis/vis/rasterizer.py"
    click Raytracer "https://github.com/Genesis-Embodied-AI/Genesis/blob/main/genesis/vis/raytracer.py"
    click Camera "https://github.com/Genesis-Embodied-AI/Genesis/blob/main/genesis/vis/camera.py"
    click Viewer "https://github.com/Genesis-Embodied-AI/Genesis/blob/main/genesis/vis/viewer.py"
    click Visualizer "https://github.com/Genesis-Embodied-AI/Genesis/blob/main/genesis/vis/visualizer.py"
```
