Metadata-Version: 2.4
Name: funlbm
Version: 1.2.86
Summary: funlbm
Author-email: 牛哥 <niuliangtao@qq.com>, farfarfun <farfarfun@qq.com>
Maintainer-email: 牛哥 <niuliangtao@qq.com>, farfarfun <farfarfun@qq.com>
Project-URL: Organization, https://github.com/farfarfun
Project-URL: Repository, https://github.com/farfarfun/funlbm
Project-URL: Releases, https://github.com/farfarfun/funlbm/releases
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: funtable>=1.0.25
Requires-Dist: funtecplot>=1.0.1
Requires-Dist: funutil>=1.0.14
Requires-Dist: funvtk>=1.0.9
Requires-Dist: h5py>=3.13.0
Requires-Dist: matplotlib>=3.9.4
Requires-Dist: nicegui>=2.15.0
Requires-Dist: pandas>=2.2.3
Requires-Dist: scipy>=1.13.1
Requires-Dist: tinydb>=4.8.2
Requires-Dist: torch>=2.2.0
Requires-Dist: transforms3d>=0.4.2
Requires-Dist: typer>=0.15.2

# FunLBM

[![Python Version](https://img.shields.io/badge/python-3.9%2B-blue.svg)](https://www.python.org/downloads/)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
[![Version](https://img.shields.io/badge/version-1.2.78-orange.svg)](https://github.com/farfarfun/funlbm/releases)

FunLBM 是一个基于格子玻尔兹曼方法（Lattice Boltzmann Method, LBM）的三维流体力学仿真库。该项目提供了完整的 LBM 仿真框架，包括流场分析、粒子追踪、数据可视化等功能。

## ✨ 主要特性

- 🔬 **完整的 LBM 仿真框架**：支持三维流体力学计算
- 📊 **数据分析工具**：内置流场分析和统计功能
- 🎨 **可视化支持**：集成 matplotlib 和 VTK 可视化
- 🌐 **Web 界面**：基于 NiceGUI 的交互式 Web 界面
- 🚀 **高性能计算**：支持 PyTorch 加速计算
- 📁 **多格式支持**：支持 HDF5、VTK 等多种数据格式

## 🚀 快速开始

### 安装

使用 pip 安装：

```bash
pip install funlbm
```

或者从源码安装：

```bash
git clone https://github.com/farfarfun/funlbm.git
cd funlbm
pip install -e .
```

### 基本使用

```python
from funlbm.plot.job import plt_job
from nicegui import ui

# 绘制仿真作业结果
plt_job(job_id=13995570, home="/path/to/workbench/")

# 启动 Web 界面
ui.run()
```

### 命令行工具

安装后可以直接使用命令行工具：

```bash
funlbm --help
```

## 📁 项目结构

```
funlbm/
├── analyse/          # 流场分析工具
├── base/            # 基础类和工具
├── config/          # 配置管理
├── export/          # 数据导出功能
├── file/            # 文件处理工具
├── flow/            # 流场计算核心
├── lbm/             # LBM 算法实现
├── particle/        # 粒子追踪
├── plot/            # 可视化工具
├── server/          # Web 服务器
└── util/            # 通用工具
```

## 📖 示例

查看 `example/` 目录获取更多使用示例：

- `00-plot/`: 数据可视化示例
- `config/`: 配置文件示例

## 🔧 依赖项

主要依赖包括：

- **计算核心**: `torch`, `scipy`, `numpy`
- **数据处理**: `pandas`, `h5py`
- **可视化**: `matplotlib`, `funvtk`, `funtecplot`
- **Web界面**: `nicegui`
- **工具库**: `funutil`, `funtable`

完整依赖列表请查看 `pyproject.toml`。

## 🤝 贡献

欢迎贡献代码！请遵循以下步骤：

1. Fork 本仓库
2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 开启 Pull Request

## 📄 许可证

本项目采用 MIT 许可证 - 详见 [LICENSE](LICENSE) 文件。

## 🔗 相关链接

- **GitHub**: [https://github.com/farfarfun/funlbm](https://github.com/farfarfun/funlbm)
- **Releases**: [https://github.com/farfarfun/funlbm/releases](https://github.com/farfarfun/funlbm/releases)
- **PyLBM**: [https://github.com/pylbm/pylbm](https://github.com/pylbm/pylbm) - 相关的 LBM 实现

## 👥 维护者

- **牛哥** - [niuliangtao@qq.com](mailto:niuliangtao@qq.com)
- **farfarfun** - [farfarfun@qq.com](mailto:farfarfun@qq.com)

## 📞 联系我们

如有问题或建议，请通过以下方式联系：

- 提交 [Issue](https://github.com/farfarfun/funlbm/issues)
- 发送邮件至维护者邮箱
- 访问我们的 [组织主页](https://github.com/farfarfun)
