# dBCI-data-spec

**Repository Path**: dbci/d-bci-data-spec

## Basic Information

- **Project Name**: dBCI-data-spec
- **Description**: 本仓库是dBCI项目脑机接口数据格式规范的协作平台，旨在为团队协作提供数据规范的分发、讨论、更新与版本控制支持。作为dBCI脑机接口数据格式标准化工作的核心枢纽，本仓库致力于通过结构化的协作流程，确保各参与团队对数据规范的理解一致、执行同步，并推动规范在实践中持续优化，最终提升项目数据的一致性、可共享性与协作效率。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2025-08-29
- **Last Updated**: 2026-07-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### dBCI脑机接口数据格式规范概述
本仓库是dBCI项目脑机接口数据格式规范的协作平台，旨在为团队协作提供数据规范的分发、讨论、更新与版本控制支持。作为dBCI脑机接口数据格式标准化工作的核心枢纽，本仓库致力于通过结构化的协作流程，确保各参与团队对数据规范的理解一致、执行同步，并推动规范在实践中持续优化，最终提升项目数据的一致性、可共享性与协作效率。

### 核心功能
1. 规范文档集中管理
	- 提供数据规范文档的中央存储与分发能力，确保所有团队可便捷获取最新版规范文本及历史版本。
	- 通过标准化的文档结构，降低跨团队对数据规范的理解成本，为数据采集、存储、共享等环节提供统一指导框架。
2. 协作讨论与反馈机制
	- 支持团队成员通过仓库内置工具（如Issue、Pull Request评论等）对数据格式规范内容提出疑问、建议或修改需求，形成开放透明的讨论环境。
	- 汇聚多团队视角，促进对数据格式规范的共识达成，减少因理解偏差导致的协作障碍。
3. 版本控制与更新追踪
	- 采用版本化管理策略，完整记录规范从初稿到迭代优化的全流程历史，支持版本回溯与变更对比。
	- 通过结构化的更新流程（如分支管理、PR审核），确保规范的修改经过充分讨论与验证，保障更新的科学性与严谨性。
4. 跨团队协同支持
	- 作为数据格式规范协作的统一入口，打破团队壁垒，实现规范相关信息的高效同步，避免信息孤岛。
	- 支持多角色参与（如规范制定者、执行者、审核者），明确协作分工，提升整体协同效率。
### 使用指南
#### 获取规范文档
- 本仓库包含 **git子模块（submodule）**，用于管理扩展依赖内容。为确保完整获取所有数据规范文档及相关资源，**请使用以下指令克隆仓库**（含子模块递归拉取）：
```
git clone --recurse-submodules https://gitee.com/dbci/d-bci-data-spec.git
```
- 通过仓库分支管理，可查看特定历史版本的规范内容。
#### 参与讨论与贡献
- 若对规范有疑问或建议，可通过 Issue 提交反馈，注明讨论主题及相关背景。
- 如需提交规范修改建议，可通过 Fork仓库→创建分支→提交PR 的流程发起变更，经审核通过后合并至主分支。
#### 最新版本（Typst 源文件）

- 当前规范的最新版本源文件为仓库根目录下的 **`脑机接口数据格式规范_v1.0.0-alpha.typ`**，渲染后生成 **`脑机接口数据格式规范_v1.0.0-alpha.pdf`**。
- **什么是 Typst？** Typst 是一种现代的、基于标记语言的排版系统，功能与 LaTeX 类似，但语法更简洁、编译更快。`.typ` 文件是普通的文本源文件，可直接用任何文本编辑器修改内容、样式、章节、表格、封面元数据等。
- **如何编辑？** 直接修改 `脑机接口数据格式规范_v1.0.0-alpha.typ` 即可。文件中内容和格式通过变量（如 `#let cn-serif-font`）和 Typst 标记分离，便于维护。
- **如何渲染？** 在仓库根目录执行以下命令（使用本仓库自带的 `fonts/` 目录中的开源字体）：

```bash
conda run -p /path/to/typst-env typst compile \
  --font-path "$(pwd)/fonts" \
  "$(pwd)/脑机接口数据格式规范_v1.0.0-alpha.typ" \
  "$(pwd)/脑机接口数据格式规范_v1.0.0-alpha.pdf"
```

- 所需中文字体（思源宋体 / 思源黑体，SIL 开源字体许可证）已放置在 `fonts/` 目录下，协作者无需另行下载即可复现相同的渲染效果。

### 贡献指南
本仓库欢迎所有团队成员积极参与数据规范的优化与完善：

- 提交Issue时，请清晰描述问题或建议，必要时附相关场景说明。
- 提交PR时，需确保修改内容符合项目整体目标，且经过充分的内部讨论与验证。
- 参与代码审查（Code Review）时，请聚焦规范的合理性、可行性及对协作的影响。
许可证
[此处可根据项目实际情况填写许可证类型，如MIT License等]

**联系我们**：如有任何疑问，可通过仓库Issue或项目沟通群联系维护团队。

本仓库旨在为多团队协作提供高效的数据规范管理支持，期待通过共同努力，推动项目数据标准化工作的持续发展。
***
本仓库包含dBCI脑机接口数据格式规范的原创内容，以及位于 /nwb-schema/ 目录下的上游 NWB schema 的模块副本，该副本根据其原始 BSD 3条款许可证（BSD 3‑Clause license）包含于此。本仓库不暗示获得加利福尼亚大学（University of California）、劳伦斯伯克利国家实验室（Lawrence Berkeley National Laboratory）、美国能源部（U.S. Department of Energy）或 NWB 贡献者的认可。
上游来源（Upstream source）：https://github.com/NeurodataWithoutBorders/nwb-schema  （完整的上游 LICENSE 和 COPYRIGHT 详见 /nwb-schema/ 目录）。