Metadata-Version: 2.4
Name: orisys
Version: 0.5.4
Summary: SDK for Orisys Technology Visuotactile Sensors
Author: Orisys-Tech
Maintainer: Yijian Zhang <zhangyijian@orisys-tech.cn>
License: Proprietary
Project-URL: Homepage, https://www.orisys-tech.cn
Project-URL: Documentation, https://github.com/Orisys-Tech/orisys-sdk
Project-URL: Issues, https://github.com/Orisys-Tech/orisys-sdk/issues
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: numpy>=1.24.4
Requires-Dist: opencv-python>=4.10.0.84
Requires-Dist: scipy>=1.10.1
Requires-Dist: numba>=0.59.0
Provides-Extra: cuda12
Requires-Dist: cupy-cuda12x>=12.3.0; extra == "cuda12"
Provides-Extra: cuda13
Requires-Dist: cupy-cuda13x>=13.0.0; extra == "cuda13"
Provides-Extra: gui
Requires-Dist: open3d>=0.17.0; extra == "gui"
Requires-Dist: pyqt5>=5.15; extra == "gui"
Requires-Dist: pyqtgraph>=0.13; extra == "gui"
Provides-Extra: cuda
Requires-Dist: cupy-cuda12x>=12.3.0; extra == "cuda"
Dynamic: author
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: license
Dynamic: maintainer
Dynamic: project-url
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Orisys SDK

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

本文件是 PyPI 项目描述（`long_description`）的源文件：构建时由 `docs/publishing.md` 所述流程从**检出目录**读取（`build/wheel/package.py::PYPI_README_RELPATH`），**不会**被打进 wheel。因此不要在这里写内部仓库布局、构建流水线或发布步骤——那些内容属于仓库内的 `README.md` 与 `docs/publishing.md`。

```bash
python -m pip install orisys
```

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

## 快速开始

```bash
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"` 匹配

```python
import orisys

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

## 示例

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

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

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

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

## 支持与反馈

- 官网：[https://www.orisys-tech.cn](https://www.orisys-tech.cn)
- 问题反馈：GitHub Issues
