Преглед изворни кода

docs: update README to V0.3 - Phase 1 complete + Phase 2 P2-M1/P2-M2 complete

- Update version to V0.3, status to Phase 2 P2-M2 complete
- Add completed milestones table (Phase 1 M1-M4, Phase 2 P2-M1/P2-M2) with commit refs
- Add Web端 quick start (backend + frontend) and core API endpoints
- Update project structure with web/ directory and api_client.py
- Add remote repo URL
- Update roadmap with all completed/to-do status
- Add rule: update README after each milestone completion
javen.ye пре 1 недеља
родитељ
комит
749e7c817a
1 измењених фајлова са 106 додато и 33 уклоњено
  1. 106 33
      README.md

+ 106 - 33
README.md

@@ -4,11 +4,12 @@
 
 | 项目 | 内容 |
 |---|---|
-| 文档版本 | V0.1(Phase 1 最小闭环) |
+| 文档版本 | V0.3(Phase 2 P2-M2 完成) |
 | 作者 | Car.Lin |
 | 启动日期 | 2026-08-27 |
-| 状态 | Phase 1 开发中 |
+| 当前状态 | Phase 2 开发中(P2-M2 已完成) |
 | 设计方案 | [PCB轴向磁通电机自动化仿真系统设计方案介绍.md](PCB轴向磁通电机自动化仿真系统设计方案介绍.md) |
+| 远程仓库 | https://gogsgit.ez4l.com/carlin/pcb-afm-simulation-system |
 
 ---
 
@@ -20,15 +21,32 @@
 - **系统二(本地EXE)**:读取方案 → 驱动Motor-CAD自动仿真 → 输出结果 → 回传
 - **核心闭环**:边界条件 → 方案 → 仿真 → 结果 → 反馈调整 → 经验库积累
 
-### Phase 1 目标(当前)
+---
+
+## 已完成里程碑
+
+### Phase 1(最小闭环)— 全部完成
+
+| 里程碑 | 内容 | 状态 | Commit |
+|---|---|---|---|
+| M1 | 环境验证 + 单工况仿真脚本 | ✅ 完成 | `75347b6` |
+| M2 | 参数扫描引擎(单参数/多参数) | ✅ 完成 | `a43d971` |
+| M3 | 方案JSON接口 + 本地PySide6 GUI | ✅ 完成 | `cbd9402` |
+| M4 | 经验库雏形 + 反馈闭环 | ✅ 完成 | `f20bef9` |
 
-跑通最小闭环:**本地GUI方案编辑 → Motor-CAD自动化仿真 → 结果输出 → 经验库积累**
+**Phase 1 验证结果**(MARS-12S10P SSSR,气隙扫描3点):
+- 平均转矩 0.4677~0.5663 Nm,转矩脉动 1.75~5.45%,效率 84.93~86.35%
+- 物理趋势全部符合预期(转矩/脉动随气隙增大而减小,效率略升)
 
-- 仿真工具:Motor-CAD 2026R1(电磁仿真)
-- 拓扑:SSSR(单定子单转子)
-- 调试模型:`MARS-12S10P_SSSR_D76-C150_V5.0-0819.mot`
-- 输出指标:平均转矩、转矩脉动(%)、系统效率、总损耗
-- 通信方式:本地文件交换(simulation_plan.json → simulation_results.csv)
+### Phase 2(Web端方案系统)— 进行中
+
+| 里程碑 | 内容 | 状态 | Commit |
+|---|---|---|---|
+| P2-M1 | Web端基础框架(FastAPI + Vue3 + SQLite + CRUD API) | ✅ 完成 | `1ea7653` |
+| P2-M2 | 边界条件输入 + 方案编辑器(规则引擎生成方案) | ✅ 完成 | `a95c0db` |
+| P2-M3 | 经验库Web端 + 结果分析仪表盘 | 🔲 待开始 | — |
+| P2-M4 | 双系统API联调 + 知识库管理 | 🔲 待开始 | — |
+| P2-M5 | Phase 2 验收 | 🔲 待开始 | — |
 
 ---
 
@@ -42,28 +60,53 @@
 | Motor-CAD | 2026R1 (v261) | `echo %MOTORCAD_ACTIVEX%` |
 | Python | ≥ 3.10 | `python --version` |
 | PyMotorCAD | `pip install ansys-motorcad-core` | `python -c "import ansys.motorcad.core"` |
+| Node.js | ≥ 18(Web端前端) | `node --version` |
 | 许可证 | FlexNet `ANSYSLMD_LICENSE_FILE=1055@localhost` | ANSYS License Management Center |
 
-### 安装依赖
+### 系统二(本地仿真执行端)
 
 ```bash
+# 安装依赖
 pip install ansys-motorcad-core pyside6 pandas
-```
 
-### 运行单工况验证
-
-```bash
+# 单工况验证
 python scripts/run_single.py
-```
 
-Motor-CAD会前台弹出,求解约2分钟,结束后输出转矩、效率、损耗等指标。
+# 参数扫描
+python scripts/run_scan.py --plan simulation_plan.json
+
+# 启动本地GUI
+python scripts/run_gui.py
+```
 
-### 运行参数扫描
+### 系统一(Web端方案生成)
 
 ```bash
-python scripts/run_scan.py --plan simulation_plan.json
+# 后端
+cd web/backend
+pip install -r requirements.txt
+python run.py
+# 后端运行在 http://127.0.0.1:8000,API文档 http://127.0.0.1:8000/docs
+
+# 前端(另开终端)
+cd web/frontend
+npm install
+npm run dev
+# 前端运行在 http://localhost:5173,自动代理 /api 到后端
 ```
 
+### Web端核心API
+
+| 方法 | 路径 | 用途 |
+|---|---|---|
+| GET | `/api/health` | 健康检查 |
+| GET/POST | `/api/projects` | 项目列表/创建 |
+| GET | `/api/scan-parameters` | 可扫描参数注册表 |
+| POST | `/api/generate-plan` | 规则引擎生成方案 |
+| POST | `/api/projects/{id}/generate-plan` | 为项目生成方案 |
+| GET | `/api/plans/{id}/download` | 下载方案(系统二兼容格式) |
+| POST | `/api/plans/{id}/upload-results` | 上传仿真结果CSV |
+
 ---
 
 ## 项目结构
@@ -82,11 +125,35 @@ PCB轴向磁通电机自动化仿真系统/
 │   ├── scan_engine.py                 # 参数扫描引擎
 │   ├── plan_schema.py                 # 方案JSON Schema定义
 │   ├── experience_db.py               # 经验库(SQLite)
+│   ├── api_client.py                  # Web端API客户端(系统二↔系统一通信)
 │   └── gui/
 │       └── main.py                    # PySide6 GUI主程序
 ├── scripts/
 │   ├── run_single.py                  # 单工况快速验证
-│   └── run_scan.py                    # 命令行扫描入口
+│   ├── run_scan.py                    # 命令行扫描入口
+│   ├── run_gui.py                     # 本地GUI启动
+│   └── test_api_client.py             # API客户端测试
+├── web/                                # 系统一(Web端)
+│   ├── backend/                        # FastAPI后端
+│   │   ├── app/
+│   │   │   ├── main.py                # FastAPI入口
+│   │   │   ├── config.py              # 配置
+│   │   │   ├── database.py            # SQLAlchemy数据库
+│   │   │   ├── models/                # ORM模型(Project/Plan/Result/Experience)
+│   │   │   ├── schemas/               # Pydantic Schema
+│   │   │   ├── routers/               # API路由(projects/plans/experience/generation)
+│   │   │   └── services/
+│   │   │       └── rule_engine.py     # 规则引擎(参数注册表/范围推荐/方案生成)
+│   │   ├── requirements.txt
+│   │   └── run.py
+│   └── frontend/                       # Vue3前端
+│       ├── src/
+│       │   ├── api/index.ts           # API调用层
+│       │   ├── router/index.ts        # 路由配置
+│       │   ├── layouts/MainLayout.vue # 主布局
+│       │   └── views/                 # 页面(项目列表/详情/方案详情/经验库)
+│       ├── package.json
+│       └── vite.config.ts
 ├── models/
 │   └── MARS-12S10P_SSSR_D76-C150_V5.0-0819.mot  # 调试模型(只读)
 ├── output/                            # 仿真输出(不入库)
@@ -121,13 +188,15 @@ PCB轴向磁通电机自动化仿真系统/
 ## 项目纪律(硬性)
 
 1. **每次运行仿真前 git commit**(脚本改动先入库再跑)
-2. **结果与报告带时间戳+简要说明并提交**;报告版本化不覆盖
-3. **Motor-CAD前台运行**,跑完保持打开供人工检查
-4. **生成物不入库**(output/、*.log、build/、dist/)
-5. **原始.mot只读**,一切修改在时间戳副本上进行
-6. **参数写入后必须回读校验**,不一致标记FAILED
-7. **每个扫描点重新加载基线模型**,防止参数污染
-8. **对话与决策带时间戳记入 docs/CONVERSATION_LOG.md**
+2. **每阶段完成后更新 README.md**(版本号/状态/路线图)
+3. **结果与报告带时间戳+简要说明并提交**;报告版本化不覆盖
+4. **Motor-CAD前台运行**,跑完保持打开供人工检查
+5. **生成物不入库**(output/、*.log、build/、dist/、node_modules/)
+6. **原始.mot只读**,一切修改在时间戳副本上进行
+7. **参数写入后必须回读校验**,不一致标记FAILED
+8. **每个扫描点重新加载基线模型**,防止参数污染
+9. **对话与决策带时间戳记入 docs/CONVERSATION_LOG.md**
+10. **所有 .py / .ps1 源码纯 ASCII**,中文用 Unicode 转义或放 Markdown
 
 ---
 
@@ -135,10 +204,14 @@ PCB轴向磁通电机自动化仿真系统/
 
 | 阶段 | 目标 | 状态 |
 |---|---|---|
-| **M1** | 环境验证 + 单工况仿真脚本 | 进行中 |
-| **M2** | 参数扫描引擎(单参数/多参数) | 待开始 |
-| **M3** | 方案JSON接口 + 本地GUI(方案编辑+执行监控) | 待开始 |
-| **M4** | 经验库雏形 + 反馈闭环 | 待开始 |
-| Phase 2 | Web端方案系统基础框架 | 规划中 |
-| Phase 3 | 算法增强(Morris/LHS/Kriging/NSGA-II)+ DRSS拓扑 | 规划中 |
-| Phase 4 | 多物理场(热/结构)+ 多工具扩展 | 规划中 |
+| **Phase 1 M1** | 环境验证 + 单工况仿真脚本 | ✅ 完成 |
+| **Phase 1 M2** | 参数扫描引擎(单参数/多参数) | ✅ 完成 |
+| **Phase 1 M3** | 方案JSON接口 + 本地GUI | ✅ 完成 |
+| **Phase 1 M4** | 经验库雏形 + 反馈闭环 | ✅ 完成 |
+| **Phase 2 P2-M1** | Web端基础框架(FastAPI + Vue3 + SQLite) | ✅ 完成 |
+| **Phase 2 P2-M2** | 边界条件输入 + 方案编辑器(规则引擎) | ✅ 完成 |
+| **Phase 2 P2-M3** | 经验库Web端 + 结果分析仪表盘 | 🔲 待开始 |
+| **Phase 2 P2-M4** | 双系统API联调 + 知识库管理 | 🔲 待开始 |
+| **Phase 2 P2-M5** | Phase 2 验收 | 🔲 待开始 |
+| Phase 3 | 算法增强(Morris/LHS/Kriging/NSGA-II)+ DRSS拓扑 | 🔲 规划中 |
+| Phase 4 | 多物理场(热/结构)+ 多工具扩展 | 🔲 规划中 |