代码与设计导航#
先按要修改的功能找到源码,再阅读该模块的 TODO 和 Current。 目录职责与运行入口见 仓库组织指南,跨模块数据流见 系统总览。
按任务定位#
源码路径相对仓库根目录。每个模块的 TODO 提供当前事项及 API、架构、proposal 的入口。
要修改什么 |
源码入口 |
设计入口 |
|---|---|---|
形态构造、连接、统计 |
|
|
SWC/ASC、checkpoint、在线形态读取 |
|
|
区域、位点与连续采样 |
|
|
机制声明与注册 |
|
|
通道与离子动力学 |
|
|
Cell、离散与运行时绑定 |
|
|
单室模型 |
|
|
突触动力学 |
|
|
网络、事件源与连接 |
|
|
数值积分与电压求解 |
|
|
参数选择与学习映射 |
|
|
图形展示 |
|
内部源码路径与公共导入名不同。例如 Branch、Morphology 从 braincell 顶层导入,
机制声明从 braincell.mech 导入;实际调用以对应模块 Current 的公开入口为准。
实验、验证和性能工作流#
通用实验梯度接口在 braincell.experimental.optim,使用流程在 examples/optim/。
数值精度对照在 validation/,性能与规模测试在 benchmarks/,共享参考资料在 data/。
小脑模型按 data/cerebellum/<model>/ 管理形态、MOD 和参数;编译输出写入 validation 的 artifacts。
具体命令见 仓库组织指南。
阅读与更新顺序#
从模块 TODO 找到事项;Current 描述当前行为,proposals 保存尚需讨论或实施的方案。
对照源码和相邻
*_test.py,确认现有约束和实际使用方式。查看对应示例或数值对照,确定修改后要验证的结果。
实现后更新受影响的 Current、示例和事项状态;必要的历史决定按日期保存在 specs。
新增机制的步骤见 扩展指南,测试定位与 fixture 用法见 测试指南。 Design 的文档分工和状态定义由 Design 规范 维护。