HS$^3$ 实用工具

Python HS$^3$ 实用工具（《hs3》）是一个命令行工具和实用程序的集合，旨在支持高能物理统计序列化标准（HS$^3$）。此软件包提供用于处理HS$^3$ JSON文件的工具，包括生成GraphML表示和比较HS$^3$文件的功能。

功能

• hs3diff：用于比较两个HS$^3$ JSON文件并生成差异的工具。
• hs3tographml：用于将HS$^3$ JSON文件转换为GraphML格式的工具，以便可视化。

安装

您可以使用pip从PyPI安装HS$^3$实用工具。

pip install hs3

或者，您可以克隆此存储库并本地安装软件包

git clone https://github.com/hep-statistics-serialization-standard/python-hep-statistics-serialization-standard
cd python-hep-statistics-serialization-standard
pip install .

使用方法

hs3diff

hs3diff用于比较两个HS$^3$ JSON文件并输出差异。

使用示例

hs3diff file1.json file2.json

此命令将输出 file1.json 和 file2.json 之间的差异。

hs3tographml

hs3tographml 将 HS$^3$ JSON 文件转换为 GraphML 文件，可以使用 Gephi 等工具进行可视化。

使用示例

hs3tographml -i model.json -o model.graphml

此命令将 model.json 转换为 model.graphml。

选项

• -i, --input：输入 JSON 文件（必需）。
• -o, --output：输出 GraphML 文件（必需）。
• -l, --likelihood：要使用的似然名称（可选）。

贡献

欢迎贡献！如果您想为 HS$^3$ 工具做出贡献，请按照以下步骤操作

• 分叉仓库。
• 创建一个新的分支（git checkout -b feature-branch）。
• 进行更改并提交（git commit -am '添加新功能'）。
• 推送到分支（git push origin feature-branch）。
• 打开拉取请求。

请确保您的代码遵循项目的编码标准，并且经过良好的测试。

许可证

本项目采用 BSD 3-Clause 许可协议。有关详细信息，请参阅 LICENSE 文件。

作者

• Carsten Burgard - cburgard@cern.ch

致谢

特别感谢贡献者和 HEP 统计标准社区对他们持续的支持和反馈。