orisys-sdk/docs/pypi_readme.md

Orisys SDK

叠动科技视触觉传感器配套的 Python SDK，提供图像采集、拼接、稠密光流、Helmholtz-Hodge 分解、接触与深度估计，以及可运行的示例。

本文件是 PyPI 项目描述（long_description）的源文件。它按构建配置 PYPI_README_RELPATH 打包进 wheel，因此不要在这里写内部仓库布局、构建流水线或发布步骤——那些内容属于仓库内的 README.md 与 docs/publishing.md。

python -m pip install orisys

支持 Python 3.10 / 3.11 / 3.12，Windows x64 与 Ubuntu x64。

快速开始

python -c "import orisys; print(orisys.__version__)"
python -c "import orisys; print(orisys.list_config())"

安装选项

• orisys — CPU / 基础流程
• orisys[gui] — Qt / Open3D 可视化示例
• orisys[cuda12] / orisys[cuda13] — NVIDIA GPU 加速
• orisys[gui,cuda12] — GUI + CUDA 12

orisys[cuda] 与 orisys[cuda12] 等价。

配置

配置解析顺序：

1. 显式 JSON 文件路径
2. 内置配置名（box、mini、finger 等）
3. 产品别名（如 dd02 -> dd02-ov）
4. 向后兼容的 JSON "name" 匹配

import orisys

sensor = orisys.Sensor(0, config_name="box")
orisys.export_config("box", "./exported_config.json")

示例

示例随 wheel 一起分发，位于 orisys/examples/。也可以从项目仓库获取：

python examples/basic_pipeline.py -v 0 -c box
python examples/finger_pipeline.py --camera_id 0 --config finger

无相机时可以改用视频文件：

python examples/finger_pipeline.py --video ./sample.mp4 --config finger

支持与反馈

• 官网：https://www.orisys-tech.cn
• 问题反馈：GitHub Issues