lingyuzeng
3e07402f4e
Add a public numbering module and route fragmenting, validation, and scaffold preparation through the canonical numbering entry. Rewrite the repository entry docs around the fixed numbering contract, add MkDocs landing pages, and document the mirror mapping used for medicinal-chemistry comparisons. Also refresh the validation analysis reports to explain the canonical-versus-mirrored numbering relationship.
30 lines
1.1 KiB
Markdown
30 lines
1.1 KiB
Markdown
# 项目结构
|
||
|
||
这是当前仓库里真正承担职责的目录划分。
|
||
|
||
## 顶层目录
|
||
|
||
- `src/macro_lactone_toolkit/`: 正式 Python 包，包含分析、编号、裂解、可视化、工作流和验证模块。
|
||
- `scripts/`: 薄封装和批处理脚本，基于正式包接口运行。
|
||
- `tests/`: pytest 测试，覆盖入口、脚本和核心行为。
|
||
- `docs/`: 面向使用者和维护者的入口文档。
|
||
- `notebooks/`: 探索性或归档性的 notebook，不作为权威接口说明。
|
||
- `validation_output/`: 生成的验证产物和报告，属于输出，不是核心源码。
|
||
|
||
## 关键入口
|
||
|
||
- `macro_lactone_toolkit.analyzer.MacroLactoneAnalyzer`
|
||
- `macro_lactone_toolkit.fragmenter.MacrolactoneFragmenter`
|
||
- `macro-lactone-toolkit` CLI
|
||
|
||
## 结构约束
|
||
|
||
- 代码和文档都只认 canonical numbering。
|
||
- 16 元环镜像映射按 `p_mirror = ring_size - p + 3` 处理。
|
||
- 不用 `clockwise` / `anticlockwise` 参数来表达编号方向。
|
||
|
||
## 维护提示
|
||
|
||
- `scripts/README.md` 解释脚本层的现状。
|
||
- `docs/project-docs/AGENTS.md` 只是项目文档入口，不是权威 agent 入口。
|