heputils

围绕Scikit-HEP生态系统的HEP常见任务的帮助工具

这个库并不打算广泛使用，并且可能会在Scikit-HEP库出现时被弃用。 这个库应被视为API设计决策的测试平台。

安装

在一个全新的虚拟环境中，您可以使用以下命令从PyPI进行安装

python -m pip install heputils

开发版本

如果您想安装不受支持的开发版本，您可以从TestPyPI进行安装。首先，像正常一样从PyPI安装heputils以获取所有依赖项的稳定版本

python -m pip install heputils

然后，使用以下命令从TestPyPI安装heputils的开发版本

python -m pip install --upgrade --extra-index-url https://test.pypi.org/simple/ --pre heputils

这将获取与main上最近提交对应的TestPyPI上的版本。

当然，您也可以先克隆仓库，然后在仓库的顶级目录中运行以下命令来“本地”直接从Git仓库安装

python -m pip install .

贡献

由于这个库是实验性的，因此欢迎所有形式的贡献。如果您有关于如何改进API或如何构建一个旨在介绍Scikit-HEP生态系统的新手库的结构的想法，请提交一个Issue。当然，您也可以自由地提交PR。

开发

要开发，请使用虚拟环境。一旦环境被激活，从GitHub克隆repo

git clone git@github.com:matthewfeickert/heputils.git

并安装所有必要的开发包

python -m pip install --ignore-installed --upgrade --editable .[complete]

然后通过运行来设置Git预提交钩子

pre-commit install

致谢

这个库建立在Scikit-HEP生态系统许多人的辛勤工作之上，并且之所以能够实现，仅仅是因为人们之间思想的交流和共同努力，他们跨越实验和领域来改进科学。这不是必然的，而是通过有目的的思考、时间和努力实现的，我对能够从中受益并参与其中感到非常感激。

请求

在您的论文中引用您使用的软件。