Metadata-Version: 2.4
Name: orca-sph
Version: 26.3.1
Summary: OrcaSPH - SPH Fluid Simulator with OrcaLink Integration
Home-page: https://github.com/your-repo/OrcaSPH
Author: OrcaSPH Team
Author-email: 
License-Expression: LicenseRef-Proprietary
Keywords: sph,fluids,simulation,orca,orcalink,fluid-dynamics
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: orca-link==26.3.1
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

# OrcaSPH - SPH Fluid Simulator with OrcaLink Integration

OrcaSPH 是一个 Python 包，提供 SPHSimulator 可执行程序和相关的库文件，支持通过 `pip install orca-sph` 安装，使用 `orcasph` 命令运行。

OrcaSPH 基于 SPlisHSPlasH 流体仿真引擎，集成了 Orca 系统的两个核心功能模块：

- **OrcaLink**：支持 SPH 仿真器与 OrcaLink 服务器的 gRPC 通信，实现流体对刚体的作用力传输和刚体位置/速度接收
- **ParticleRender**：支持粒子数据通过 gRPC 实时传输到渲染服务

Orca 集成允许在分布式系统中运行 SPlisHSPlasH 模拟器，并与其他计算节点进行实时数据交换。

## 系统要求

- **Python**：3.10+ （不再支持 3.8 和 3.9）
- **操作系统**：Linux (x86_64)
- **系统库**：已安装必要的系统库（libGL, libX11 等）

## 安装

### 从 PyPI 安装（推荐）

```bash
pip install orca-sph
```

安装后可以使用：
- **命令行工具**：`orcasph --help`
- **Python 模块**：`import orcasph_client`

## 基本用法

### 启动仿真

```bash
orcasph --scene path/to/scene.json
```

### 常用选项

使用 `orcasph --help` 查看完整的命令行选项，包括：
- `--scene FILE`：场景文件路径（必需）
- `--cpu RANGE`：指定 CPU 核心范围
- `--threads N`：指定 OpenMP 线程数
- `--config FILE`：gRPC 配置文件路径
- `--gui`：启用 GUI 模式运行

## 许可证

本包采用双许可证：

- **SPlisHSPlasH 核心代码**：MIT License (Copyright © 2016 Jan Bender)
- **Orca 扩展**：Proprietary License (Copyright © 2026 Songying Technology Inc.)

详细信息请参考 `LICENSE` 文件。
