Metadata-Version: 2.4
Name: research-assistant-xf
Version: 1.8.0
Summary: Multi-layer Research Automation Framework — from data collection to autonomous paper generation
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: numpy>=1.24
Requires-Dist: pandas>=2.0
Requires-Dist: scipy>=1.10
Requires-Dist: matplotlib>=3.7
Requires-Dist: statsmodels>=0.14
Requires-Dist: networkx>=3.0
Provides-Extra: async
Requires-Dist: aiohttp>=3.9; extra == "async"
Requires-Dist: httpx>=0.25; extra == "async"
Provides-Extra: api
Requires-Dist: fastapi>=0.104; extra == "api"
Requires-Dist: uvicorn>=0.24; extra == "api"
Provides-Extra: dashboard
Requires-Dist: streamlit>=1.28; extra == "dashboard"
Provides-Extra: distributed
Requires-Dist: ray>=2.8; extra == "distributed"
Provides-Extra: llm
Requires-Dist: openai>=1.0; extra == "llm"
Provides-Extra: test
Requires-Dist: pytest==9.1.1; extra == "test"
Requires-Dist: PyYAML==6.0.3; extra == "test"
Requires-Dist: pytest-cov>=4.1; extra == "test"
Provides-Extra: lint
Requires-Dist: mypy>=1.7; extra == "lint"
Requires-Dist: ruff>=0.1; extra == "lint"

# research_assistant

多层研究自动化框架：从数据采集到论文自动生成的一体化流水线，内置数据层、分析层、写作层三层架构，支持经济地理等科研领域的批量研究任务。

## 安装

```bash
pip install research_assistant
```

## 快速开始

```python
import research_assistant
from research_assistant import orchestrator
```

## 特性

- 数据层：多源数据采集、清洗、质量校验
- 分析层：因果推断、空间计量、面板模型、鲁棒性检验
- 写作层：报告模板适配、DOCX 输出、审稿回复
- 辅助能力：依赖自检、唤醒管道、CI 集成、可复现性锁定

## 测试

```bash
pytest tests/
```



## 策略落实保障（跨对话检查入口）

框架策略的单一事实来源为 `docs/协作准则与工作规范.md`（含策略落实保障章节，当前 18 条）；任何新对话涉及本框架时，先按以下入口获取策略落实基线：

```bash
python scripts/policy_check.py --quick   # 轻量自检：测试收集、标记扫描、依赖、唤醒、发布产物、文档、改进项
python scripts/policy_check.py --json    # JSON 输出，供脚本消费
python scripts/policy_check.py --full    # 完整模式：额外运行 pytest tests/ 全量并断言 0 警告
```

- 退出码 0 = 全部通过；1 = 存在失败项，须定位根因并修复后再继续任务。
- CI（.github/workflows/ci.yml）已将该自检接入矩阵门禁，策略回归会阻断合并。
- 框架改动后建议按 `docs/协作准则与工作规范.md` 第十七条执行每轮落实检查清单。
