示例HEP文件,用于测试和演示
项目描述
scikit-hep-testdata
一个常用的包,提供用于测试和开发的示例文件(例如ROOT文件),这些文件样本代表在野外发现的典型文件。
除了直接包含一些root文件外,此包还添加了一些简单的辅助方法,以从常见的开源数据存储库中获取更大的文件。
安装和使用
安装
python -m pip install scikit-hep-testdata
安装完成后,可以使用辅助方法解析绝对文件路径
from skhep_testdata import data_path
filename = data_path("some_file.root")
默认情况下,如果请求未知文件,将引发异常,但可以通过传递上述方法 raise_missing=False
来跳过
filename = data_path("unknown_file.root", raise_missing=False)
这些文件未存储在PyPI上,因此如果从SDist/wheel安装,则“本地”文件将不存在,但将从GitHub下载并缓存在~/.local/skhepdata
目录中。如果您从Git存储库进行可编辑安装,或如果您在从Git存储库构建/安装时设置SKHEP_DATA=1
,则将在本地拥有数据文件。
您可以使用skhep_testdata.known_files
查看所有“本地”文件,并可以使用skhep_testdata.download_all()
一次性下载所有文件,可选地选择下载缓存目录。
远程文件与本地文件
一些文件,尤其是大文件,例如,不存储在此包中,而是在远程服务器上;我们称这些为“远程文件”。要获取这些文件,可以使用上述相同的data_path
方法,但是这将触发代码下载和配置远程文件。这可能会在第一次运行时较慢,但之后将像本地文件一样快速。警告:本地文件缓存系统尚未应用于远程文件。
命令行调用
您还可以从命令行与此包交互
# Print a path (download if needed)
python -m skhep_testdata cms_hep_2012_tutorial/data.root
# Show all "local" files
python -m skhep_testdata --list
# Download all files to an existing directory
python -m skhep_testdata --all --dir local
您还可以使用pipx run scikit-hep-testdata
来访问上述CLI而不进行安装。
添加新文件
我们正在寻找新的、有趣的文件!
- 大文件:如果文件特别大,例如 > 25 MB,则可能值得将其添加到外部开放访问数据存储库,并在此添加配置,以便内部辅助方法可以下载它。
- 实验数据政策:请确保您有权限将文件添加到此集合,并且任何私有或敏感数据都已适当遮蔽、加盐或打乱。
文件列表
以下列表描述了此包已知的文件。
存储在此包中的文件
已知远程文件
贡献者
我们在此感谢使此项目成为可能的所有贡献者(表情符号键)
本项目遵循all-contributors 规范。
致谢
- 此包中收集的许多文件最初由Jim Pivarski收集,用于uproot
运行测试
本包使用pytest
运行单元测试。使用pip install scikit-hep-testdata[test]
或pip install -e .[test]
(开发版)安装测试需求,然后运行
pytest
项目详情
下载文件
下载适用于您的平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。
源代码分布
构建分布
scikit_hep_testdata-0.4.48.tar.gz 的散列值
算法 | 散列摘要 | |
---|---|---|
SHA256 | d2b8142119e74cd2df0565db3e24a73356a03a5c55f85b61addcb13e47c8c1e3 |
|
MD5 | 0440f403342ea5196f20de986ed8468b |
|
BLAKE2b-256 | bdc14dfdd147e2de3ae62cf2a7282e5524ad12c86d651b99b54193591d4c8580 |