HEDTools - Python

HED（分层事件描述符）是一个框架，用于系统性地描述实验室和现实世界的事件以及其他实验元数据。HED标签是逗号分隔的路径字符串。HED本身是平台无关的、可扩展的且数据中立的。

该存储库包含支持使用HED标签验证、汇总和分析数据集的底层Python工具。

大多数人将简单地通过创建一个与事件代码或事件本身关联HED标签的电子表格或BIDS JSON侧边栏来注释他们的事件。如果您有这样的电子表格或JSON，您可以使用目前可在https://hedtools.org找到的HED在线验证器来验证或转换您的文件，而无需下载任何工具。

对应于 develop 分支的在线工具版本可在以下地址找到： https://hedtools.org/hed_dev。

安装

使用 pip 从 PyPI 安装 hedtools

    pip install hedtools

直接从 GitHub 仓库的 master 分支安装

    pip install git+https://github.com/hed-standard/hed-python/@master

此仓库中的 HEDTools 需要 Python 3.8 或更高版本。

与其他仓库的关系

hed-python 仓库包含验证和分析 HED 的 Python 基础设施。此仓库有几个配套仓库

• hed-web 包含 HED 的 Web 界面以及一个可部署的 Docker 模块，支持 HED 的 Web 服务。
• hed-examples 包含使用 Python 和 MATLAB 的 HED 示例。此仓库还包含 HED 资源。有关访问这些资源的详细信息，请参阅 https://www.hed-resources.org。
• hed-specification 包含 HED 规范文档。 hed-python 验证器与该文档中的错误代码相关联。
• hed-schemas 包含官方 HED 架构。工具在执行期间访问此仓库以检索和缓存架构版本。从 hedtools 0.2.0 开始，最新架构版本的本地副本存储在代码模块中，以便于访问。

开发分支与 master 分支与稳定分支的区别

hed-python 仓库

随着功能的集成，它们首先出现在仓库的 develop 分支中。尽可能保持仓库的 develop 分支同步。如果 hed-python 中的接口更改触发了 hed-web 或 hed-examples 的更改，将尽力使相应仓库的 develop、latest 和 stable 三种类型的分支保持同步。

当在任何三个分支之一上推送新版本时，在 ReadTheDocs 上生成 API 文档。例如，latest 分支的 API 文档可在 hed-python.readthedocs.io/en/latest/ 上找到。

参与贡献

欢迎贡献。请使用 Github issues 进行建议或错误报告。也可以使用 Github pull request 进行贡献。这些 PR 应提交到 develop 分支，而不是 master 分支。

本地设置存储

默认情况下，缓存的架构存储在 "home/.hedtools/"。 "home" 目录的位置因操作系统而异。

使用 hed.schema.set_cache_directory 更改位置。HED 缓存可以在进程间共享。

从 hedtools 0.2.0 开始，最新架构版本的本地副本存储在代码模块中，以便于访问。

其他感兴趣的相关链接

代码气候报告： https://codeclimate.com/github/hed-standard/hed-python。