完成求解器雅可比矩阵首轮优化,增加更新目录,整理了文档文件夹,增加了服务启动脚本
This commit is contained in:
1 parent
6bb0591d32
commit
16a7eb2d6c
48 files changed
+8172
-217
No files matched your search
+24
-52
@@ -1,65 +1,37 @@
|
||||
# 开发文档索引
|
||||
# 文档目录说明
|
||||
|
||||
本目录是 SystemSimulationApp 协议和开发规范的统一入口。
|
||||
本目录是 SystemSimulationApp 更新日志、现行标准和其他技术报告的统一入口。
|
||||
|
||||
跨 HTTP、组件目录、模型合同和 System XML 的版本边界统一见
|
||||
[后端接口版本与定义规范 v1](backend-interface-version-spec-v1.md)。
|
||||
## 目录职责
|
||||
|
||||
## 更新记录
|
||||
| 目录 | 职责 |
|
||||
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| [`update-log/`](update-log/) | 按日期保存每日更新日志,记录当天已经完成的上传、修改及其影响。 |
|
||||
| [`standard/`](standard/) | 保存当前采用的标准、协议和开发规范。实现、评审和 AI 修改代码时,应优先以这里的文档为准。 |
|
||||
| [`other/`](other/) | 保存不属于现行标准的其他文档,例如性能仿真报告、优化报告、调研记录和技术总结。这些文档主要用于分析和参考,不默认作为强制规范。 |
|
||||
|
||||
- [更新日志 2026-08-15](更新日志-2026-08-15.md)
|
||||
新增或移动文档时,应根据文档用途放入对应目录。目录链接可用于查看其中的全部文档,无需在本文件中逐项维护清单。
|
||||
|
||||
## 求解与性能
|
||||
## `update-log` 书写规范
|
||||
|
||||
- [后端求解逻辑与效率优化调研](后端求解逻辑与效率优化调研.md)
|
||||
- [仿真性能评估 2026-08-15](仿真性能评估-2026-08-15.md)
|
||||
以下规范适用于新建和后续追加的日志。历史日志缺少准确完成时间时,不猜测或补写时间。
|
||||
|
||||
## 模型开发
|
||||
1. 按日期填写日志。每个文件只记录一天的更新,文件名使用 `更新日志-YYYY-MM-DD.md`,标题使用 `# 更新日志 YYYY-MM-DD`。
|
||||
2. 同一天内有多次上传或更新时,按各项工作的实际完成时间分段记录。每段使用北京时间、24 小时制的 `## HH:mm` 标注时间,并按完成时间从早到晚排列。
|
||||
3. 不同时间完成的内容应分别记录,不要合并到同一时间段。一次上传或更新包含多项相关修改时,可以写在同一时间段内。
|
||||
4. 语言应简短且信息充分,让 AI 和人都能快速理解。优先说明完成了什么、结果是什么、影响哪些范围,删除重复描述和无关过程。
|
||||
5. 尽量使用通俗易懂的语言,减少难以理解的术语。必须使用专业术语时,应提供必要的简短说明。
|
||||
|
||||
1. [组件模型建模规范 v1](component-model-authoring-spec-v1.md)
|
||||
用于创建或修改模型,包括端口、参数、结果、方程、版本、测试和 AI 修改协议。
|
||||
2. [组件库分类、发现与读取规范 v1](component-library-spec-v1.md)
|
||||
用于理解组件库清单、自动发现、启动校验、目录接口和前端读取流程。
|
||||
3. [组件目录 JSON Schema v1](../schemas/component-catalog-v1.schema.json)
|
||||
`GET /api/components/catalog` 的机器可读结构。
|
||||
4. [AMESim 子模型公开组件迁移矩阵](amesim-component-migration-matrix.md)
|
||||
用于划分 `test_mql` 子模型族的公开组件、内部模型和暂不支持范围。
|
||||
5. [AMESim 氦气 Peng-Robinson 介质模型](amesim-helium-peng-robinson.md)
|
||||
记录本地 AMESim 资料、氦气参数、索引映射和首版计算边界。
|
||||
推荐格式:
|
||||
|
||||
建议人工和 AI 先阅读建模规范,再阅读读取规范,然后参考目标分类中最接近的现有
|
||||
模型。不要从前端兜底数据反推后端物理契约。
|
||||
```markdown
|
||||
# 更新日志 YYYY-MM-DD
|
||||
|
||||
## System XML
|
||||
## HH:mm
|
||||
|
||||
- [System XML v3 协议(当前规范)](system-xml-v3.md)
|
||||
- [System XML v3 XSD(当前 Schema)](../schemas/system-simulation-v3.xsd)
|
||||
- 完成的修改、结果及影响范围。
|
||||
|
||||
新增模型时,模型类和组件库清单是后端事实来源;System XML v3 只保存求解所需的
|
||||
组件实例、模型版本、参数、连接和仿真设置。端口契约由注册模型恢复,画布位置、图标
|
||||
方向等编辑信息只属于工程 JSON。XML 解析器不能自行创造模型端口或参数。
|
||||
## HH:mm
|
||||
|
||||
## 当前代码入口
|
||||
|
||||
| 目的 | 文件 |
|
||||
| --- | --- |
|
||||
| 组件基类 | [`app/simulation/core/base.py`](../app/simulation/core/base.py) |
|
||||
| 端口契约 | [`app/simulation/core/ports.py`](../app/simulation/core/ports.py) |
|
||||
| 参数与结果元数据 | [`app/simulation/core/metadata.py`](../app/simulation/core/metadata.py) |
|
||||
| 库和显示声明 | [`app/simulation/core/catalog.py`](../app/simulation/core/catalog.py) |
|
||||
| 库发现与注册校验 | [`app/simulation/registry.py`](../app/simulation/registry.py) |
|
||||
| 临时库清单 | [`app/simulation/components/experimental/library.py`](../app/simulation/components/experimental/library.py) |
|
||||
| AMESim 第一版公开临时库清单 | [`app/simulation/components/amesim/library.py`](../app/simulation/components/amesim/library.py) |
|
||||
| `test_mql` 固定算例入口 | [`app/simulation/examples/test_mql/system.py`](../app/simulation/examples/test_mql/system.py) |
|
||||
| 元件完整示例 | [`app/simulation/components/example.md`](../app/simulation/components/example.md) |
|
||||
| System XML v3 解析与语义校验 | [`app/system_xml.py`](../app/system_xml.py) |
|
||||
| System XML v3 XSD | [`schemas/system-simulation-v3.xsd`](../schemas/system-simulation-v3.xsd) |
|
||||
|
||||
## AI 使用原则
|
||||
|
||||
- 先读规范和相邻模型,再改代码。
|
||||
- 只从 `library.py` 受控登记公开模型。
|
||||
- 不在前端复制后端端口、参数或默认值作为正式来源。
|
||||
- 不覆盖用户已有改动。
|
||||
- 不自行猜测缺失的物理方程。
|
||||
- 修改后运行针对性测试和完整回归,并报告未完成的验证。
|
||||
- 完成的修改、结果及影响范围。
|
||||
```
|
||||
Reference in new issue
Block a user