guzhujushi
5319589dfd
审查并精简 ChatGPT 的建库建议后落地的第一版骨架，只定接口不写实现。 - 建议审查：14 个包 → 7 个；约 250 个函数 → 约 40 个；5 个 Result 类 → 1 个 （docs/01-suggestion-review.md） - docs/：架构、路线图（含永久不做清单）、环境、Git 工作流、函数卡片模板 - src/mcm_toolkit/：core / data / stats / models / solve / decision / viz 共 23 个模块，均为签名 + docstring + NotImplementedError - tests/：9 个文件，其中 test_api_surface.py 已通过（20 passed） - examples/ problems/ notebooks/ figures/ tables/ 骨架 - pyproject.toml（核心依赖 4 个 + 6 组 extras）、environment.yml - scripts/：setup-venv.ps1（ASCII + LF）、setup-conda.ps1、doctor.ps1 - 环境：.venv（system-site-packages）与 conda 环境 mcm-toolkit 均已建好， 数值栈版本与 base 完全对齐（numpy 2.4.6 / scipy 1.18.1 / pandas 3.0.6，MKL 后端）
21 lines
1.1 KiB
Markdown
21 lines
1.1 KiB
Markdown
# 文档索引
|
|
|
|
本目录是 MCM/ICM Toolkit 的需求、架构、方案与开发规范的**唯一落盘处**。
|
|
|
|
| 文档 | 内容 |
|
|
|---|---|
|
|
| [01-suggestion-review.md](01-suggestion-review.md) | 对 ChatGPT 建库建议的**审查与精简**：留什么、砍什么、补什么 |
|
|
| [02-architecture.md](02-architecture.md) | 精简后的包结构、边界划分、统一接口约定 |
|
|
| [03-roadmap.md](03-roadmap.md) | 功能清单分级（L0 / L1 / L2 / 不做）与开发纪律 |
|
|
| [04-environment.md](04-environment.md) | conda / venv 环境配置、镜像、离线约束 |
|
|
| [dev/function-card-template.md](dev/function-card-template.md) | S 档算法的「函数卡片」模板 |
|
|
|
|
## 阅读顺序
|
|
|
|
1. 先读 `01-suggestion-review.md` —— 它决定后面所有事。
|
|
2. 再读 `02-architecture.md` —— 它决定代码往哪写。
|
|
3. 开工前读 `03-roadmap.md` 的对应条目 —— 它决定这次做什么、做到什么程度。
|
|
4. 环境出问题看 `04-environment.md`。
|
|
|
|
> 项目级进度看根目录的 `STATUS.md`；本目录只放**不会频繁变**的内容。
|