Metadata-Version: 2.4
Name: openkarhydro
Version: 0.2.1
Summary: An eco-hydrological model assessing impacts of human activities (terrace abandonment, PV stations, urbanization) on water cycle and soil erosion
Author: OpenKarHydro Contributors
License-Expression: GPL-3.0-or-later
Project-URL: homepage, https://github.com/LiuDongDong1989/OpenKarHydro
Project-URL: documentation, https://github.com/LiuDongDong1989/OpenKarHydro/tree/main/docs
Project-URL: source, https://github.com/LiuDongDong1989/OpenKarHydro
Project-URL: tracker, https://github.com/LiuDongDong1989/OpenKarHydro/issues
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.20
Requires-Dist: scipy>=1.7
Requires-Dist: pydantic>=2.0
Requires-Dist: xarray>=2023.0
Requires-Dist: pandas>=1.3
Requires-Dist: matplotlib>=3.5
Requires-Dist: pyyaml>=6.0
Requires-Dist: netCDF4>=1.5
Requires-Dist: click
Requires-Dist: rasterio
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"
Dynamic: license-file

# OpenKarHydro

人类活动（梯田撂荒、光伏电站、城市化）对水文循环与土壤侵蚀影响的评估工具。

基于 NOAH-MP 物理过程，用 Python 重写的开源水文生态模拟模型。能够模拟梯田撂荒、光伏电站建设、城市化等人类活动对局地水文循环和土壤侵蚀过程的影响。

## 安装

```bash
pip install openkarhydro
```

需要 Python 3.12+。

## 快速开始

```bash
# 创建新项目
openkarhydro init my_project
cd my_project

# 将 DEM、气象数据放入 inputs/ 目录
# 编辑 config.yaml 配置参数

# 运行模拟
openkarhydro run config.yaml --output outputs/

# 后处理（生成 SQLite + 空间统计）
openkarhydro postprocess outputs/ --db outputs/results.sqlite
```

输出文件：
| 文件 | 格式 | 说明 |
|:----|:----|:-----|
| `timeseries.csv` | CSV | 逐日时间序列（Excel 可用） |
| `results.sqlite` | SQLite | 日/月/年表 + 空间统计（QGIS 可查） |
| `*.LDASOUT_DOMAIN1.nc` | NetCDF | CF-1.6 空间格点数据（QGIS 直接打开） |

## QGIS 插件

安装核心包后，在 QGIS 中搜索 `OpenKarHydro` 插件安装，即可在界面中完成项目创建、模型运行、结果可视化的全流程操作。

## 参考文档

- [DEVELOPMENT_DESIGN.md](docs/DEVELOPMENT_DESIGN.md) — 架构设计
- [HPC_GUIDE.md](docs/HPC_GUIDE.md) — 超算使用指南
- [QGIS_PLUGIN_DESIGN.md](docs/QGIS_PLUGIN_DESIGN.md) — QGIS 插件设计
