Metadata-Version: 2.3
Name: motrixsim-gpu
Version: 0.7.1.dev101648
Summary: 
Author: heng.zhang
Author-email: heng.zhang <heng.zhang@motphys.com>
Requires-Dist: warp-lang==1.11.0 ; platform_machine != 'x86_64' or sys_platform != 'darwin'
Requires-Dist: motrixsim-core==0.7.1.dev101648
Requires-Dist: mujoco-warp ; (platform_machine != 'x86_64' and extra == 'bench') or (sys_platform != 'darwin' and extra == 'bench')
Requires-Dist: mujoco ; extra == 'bench'
Requires-Dist: absl-py ; extra == 'bench'
Requires-Dist: nvtx>=0.2.13 ; extra == 'bench'
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: autodocsumm ; extra == 'docs'
Requires-Dist: pydata-sphinx-theme ; extra == 'docs'
Requires-Dist: myst-parser ; extra == 'docs'
Requires-Dist: sphinx-copybutton ; extra == 'docs'
Requires-Dist: sphinx-subfigure ; extra == 'docs'
Requires-Dist: sphinxcontrib-video ; extra == 'docs'
Requires-Dist: sphinx-togglebutton ; extra == 'docs'
Requires-Dist: sphinx-design ; extra == 'docs'
Requires-Dist: scipy ; extra == 'examples'
Requires-Dist: onnxruntime ; (platform_machine != 'x86_64' and extra == 'examples') or (sys_platform != 'darwin' and extra == 'examples')
Requires-Python: >=3.10, <3.14
Provides-Extra: bench
Provides-Extra: docs
Provides-Extra: examples
Description-Content-Type: text/markdown

# MotrixSim GPU

## 开发指南

### 1. 前置要求

-   UV 已安装（见[官方安装指南](https://docs.astral.sh/uv/getting-started/installation/)）

### 2. 初始化环境

```
# 安装生产依赖、所有可选依赖以及默认开发依赖组
uv sync --all-extras

# 安装生产依赖
uv sync --no-dev
```

### 3. 依赖管理

1. 添加可选依赖

    ```
    # 带有版本约束
    uv add --optional ${group_name} "${package_name}>=1.0"

    # 不带版本约束
    uv add --optional ${group_name} "${package_name}"
    ```

2. 添加生产依赖

    ```
    # 带有版本约束
    uv add "${package_name}>=1.0"

    # 不带版本约束
    uv add "${package_name}"
    ```

3. 更新锁定文件

    如果手动编辑 pyproject.toml 文件的依赖后，需要执行下面的命令来更新锁定文件：

    ```
    uv lock
    ```

### 4. 执行测试

```
uv run pytest

# pytest 依赖声明在默认安装的 dev dependency group 中。
# 如果上面只安装了生产依赖，需要先运行：uv sync --inexact
```

### 5. 代码格式化与检查

-   使用命令

```
# Lint files in the current directory
uv run ruff check
# Lint files in the current directory and fix any fixable errors
uv run ruff check --fix


# Run the Ruff formatter on the given files or directories, avoid writing any formatted files back
uv run ruff format --check
# Format all files in the current directory
uv run ruff format

# ruff 依赖声明在默认安装的 dev dependency group 中。
# 如果上面只安装了生产依赖，需要先运行：uv sync --inexact
```

-   使用 VSCode 插件

https://docs.astral.sh/ruff/editors/setup/#vs-code
