scikit-hep-testdata

A common package to provide example files (e.g., ROOT) for testing and developing packages against.

https://github.com/scikit-hep/scikit-hep-testdata

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
✓
Committers with academic emails
4 of 28 committers (14.3%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (16.8%) to scientific vocabulary

Keywords

hep high-energy-physics particle-physics scikit-hep

Keywords from Contributors

histogram cern-root apache-arrow rdataframe columnar-format ragged-array jagged-array particles pid pdg

Last synced: 9 months ago · JSON representation

Repository

A common package to provide example files (e.g., ROOT) for testing and developing packages against.

Basic Info

Host: GitHub
Owner: scikit-hep
License: bsd-3-clause
Language: C
Default Branch: main
Homepage:
Size: 350 MB

Statistics

Stars: 13
Watchers: 7
Forks: 17
Open Issues: 4
Releases: 80

Topics

hep high-energy-physics particle-physics scikit-hep

Created over 7 years ago · Last pushed 9 months ago

Metadata Files

Readme License Citation

scikit-hep-testdata

A common package to provide example files (e.g. ROOT) for testing and developing packages against. The sample of files is representative of typical files found "in the wild".

In addition to including some root files directly, this package adds some simple helper methods to get larger files from common open-access data repositories.

Installing and usage

To install:

bash python -m pip install scikit-hep-testdata

Once installed, absolute file paths can be resolved using the helper methods:

``` python from skheptestdata import datapath

filename = datapath("somefile.root") ```

By default, if an unknown file is requested an exception is raised but this can be skipped by passing the above method raise_missing=False:

python filename = data_path("unknown_file.root", raise_missing=False)

The files are not stored on PyPI, so if installed from SDist/wheel, the "local" files will not be present, but will be downloaded from GitHub and cached in the ~/.local/skhepdata directory. If you make an editable install from the Git repo, or if you set SKHEP_DATA=1 when building/installing from the Git repo, you will have the data files locally.

You can see all "local" files with skhep_testdata.known_files, and you can download all files at once with skhep_testdata.download_all(), optionally selecting the download cache directory.

Remote vs. Local files

Some files, particularly large ones, for example, are not stored within this package and instead live on a remote server; we call these "remote files". To obtain these use the same data_path method as above, however this will trigger the code to download and configure the remote file. This might be slow the first time round but will subsequently be as fast as for a local file. WARNING: the local file caching system has not yet been applied to remote files.

Command-line invocation

You can also interact with this package from the command-line:

```bash

Print a path (download if needed)

python -m skheptestdata cmshep2012tutorial/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 ```

You can also use pipx run scikit-hep-testdata to access the above CLI without installing.

Adding new files

We're on the look out for new, interesting files!

Large files: If the file is particularly large, for example > 25 MB, it might be worth adding to an external open access data repository and adding a configuration here so that the internal helper methods can pull this down.
Experiment data policies: Please make sure you have permissions to add the file to this collection, and that any private or sensitive data has been appropriately masked, salted, or scrambled.

List of files

The following lists describe the files known by this package.

Files stored in this package

Listed here

Known remote files

CMS HEP public tutorial from 2012

Contributors

We hereby acknowledge the contributors that made this project possible (emoji key):

_benkrikler	_{Jim Pivarski}	_{Henry Schreiner}	_{Eduardo Rodrigues}	_{Matthew Feickert}	_{Pratyush Das}	_{Jerry Ling}
_{Jonas Eschle}	_{Giordon Stark}	_{Dmitry Kalinkin}	_{Michele Peresano}	_{Luis Antonio Obis Aparicio}	_{Oksana Shadura}	_{Nicholas Smith}
_{Beojan Stanislaus}	_Lukas	_{Johannes Schumann}	_{Elliott Kauffman}	_{Tom Eichlersmith}	_{Alexander Puck Neuwirth}	_ioanaif
_{Andres Rios Tascon}	_{Artur Cordeiro Oudot Choi}	_{Samantha Abbott}

This project follows the all-contributors specification.

Acknowledgements

Many of the files collected directly within this package were collated originally by Jim Pivarski for uproot

Running the tests

This package uses pytest to run the unit tests. Install with pip install scikit-hep-testdata[test] or pip install -e .[test] (dev) to get the testing requirements. then run:

bash pytest

Owner

Name: Scikit-HEP Project
Login: scikit-hep
Kind: organization
Email: scikit-hep-forum@googlegroups.com

Website: https://scikit-hep.org
Repositories: 46
Profile: https://github.com/scikit-hep

A community project for High Energy Physics data analysis in Python

GitHub Events

Total

Create event: 25
Release event: 6
Issues event: 2
Delete event: 22
Issue comment event: 55
Push event: 53
Pull request review comment event: 3
Pull request review event: 21
Pull request event: 33
Fork event: 2

Last Year

Create event: 25
Release event: 6
Issues event: 2
Delete event: 22
Issue comment event: 55
Push event: 53
Pull request review comment event: 3
Pull request review event: 21
Pull request event: 33
Fork event: 2

Committers

Last synced: about 1 year ago

All Time

Total Commits: 275
Total Committers: 28
Avg Commits per committer: 9.821
Development Distribution Score (DDS): 0.698

Past Year

Commits: 26
Committers: 8
Avg Commits per committer: 3.25
Development Distribution Score (DDS): 0.577

Top Committers

Name	Email	Commits
Jim Pivarski	j**i@g**m	83
Ben Krikler	b**7@i**k	33
Henry Schreiner	h**i@g**m	31
allcontributors[bot]	4****]	24
pre-commit-ci[bot]	6****]	21
Eduardo Rodrigues	e**s@c**h	20
Andres Rios Tascon	a**s@g**m	9
ioanaif	i**m@g**m	9
Jerry Ling	p**n@j**v	7
Pratyush Das	r**s@g**m	6
Jonas Eschle	m**6@j**m	5
Matthew Feickert	m**t@c**h	4
Dmitry Kalinkin	d**n@g**m	3
Giordon Stark	k**g@g**m	3
Chris Burr	c****r	2
Luis Antonio Obis Aparicio	3****s	2
Michele Peresano	m**o@c**r	2
Alexander Puck Neuwirth	A****y	1
Artur Cordeiro Oudot Choi	5****3	1
Beojan Stanislaus	b**n@g**m	1
Elliott Kauffman	6****a	1
Johannes Schumann	j**n@f**e	1
Lukas	l**h@g**m	1
Nicholas Smith	n**h@c**h	1
Oksana Shadura	k**a@g**m	1
Samantha Abbott	5****t	1
Tom Eichlersmith	3****h	1
dependabot[bot]	4****]	1

Committer Domains (Top 20 + Academic)

cern.ch: 3 fau.de: 1 cea.fr: 1 jonas.eschle.com: 1 jling.dev: 1 ic.ac.uk: 1

Issues and Pull Requests

Last synced: 9 months ago

All Time

Total issues: 23
Total pull requests: 167
Average time to close issues: 10 months
Average time to close pull requests: 5 days
Total issue authors: 13
Total pull request authors: 25
Average comments per issue: 8.65
Average comments per pull request: 2.17
Merged pull requests: 153
Bot issues: 1
Bot pull requests: 67

Past Year

Issues: 2
Pull requests: 40
Average time to close issues: N/A
Average time to close pull requests: 2 days
Issue authors: 2
Pull request authors: 8
Average comments per issue: 0.0
Average comments per pull request: 1.85
Merged pull requests: 33
Bot issues: 0
Bot pull requests: 25

View more stats

Top Authors

Issue Authors

jpivarski (5)
benkrikler (4)
APN-Pucky (2)
ariostas (2)
veprbl (2)
eduardo-rodrigues (1)
jonas-eschle (1)
lukasheinrich (1)
badshah400 (1)
henryiii (1)
kratsg (1)
matthewfeickert (1)
pre-commit-ci[bot] (1)

Pull Request Authors

pre-commit-ci[bot] (41)
allcontributors[bot] (26)
ariostas (18)
jpivarski (17)
ioanaif (13)
henryiii (9)
Moelf (7)
eduardo-rodrigues (7)
veprbl (4)
matthewfeickert (4)
kratsg (3)
lobis (3)
ArturU043 (2)
dependabot[bot] (2)
sathabbott (2)

Top Labels

Issue Labels

enhancement (4) ci (3) help wanted (2) question (1) new ROOT data (1) bug (1)

Pull Request Labels

ci (27) new ROOT data (8) enhancement (3) docs (3) new data (2) dependencies (2) question (1)

Packages

Total packages: 2
Total downloads:
- pypi 7,914 last-month
Total docker downloads: 12

Total dependent packages: 7
(may contain duplicates)
Total dependent repositories: 5
(may contain duplicates)
Total versions: 106
Total maintainers: 4

pypi.org: scikit-hep-testdata

Example HEP files for testing and demonstrating

Homepage: https://github.com/scikit-hep/scikit-hep-testdata
Documentation: https://scikit-hep-testdata.readthedocs.io/
License: BSD-3-Clause
Latest release: 0.5.8
published 10 months ago

Versions: 71
Dependent Packages: 7
Dependent Repositories: 4
Downloads: 7,914 Last month
Docker Downloads: 12

Rankings

Dependent packages count: 1.2%

Downloads: 2.6%

Docker downloads count: 4.1%

Average: 7.0%

Dependent repos count: 7.5%

Forks count: 10.2%

Stargazers count: 16.1%

Maintainers (4)

pivarski scikit-hep eduardorodrigues ben.krikler

Last synced: 9 months ago

conda-forge.org: scikit-hep-testdata

Homepage: https://github.com/scikit-hep/scikit-hep-testdata
License: BSD-3-Clause
Latest release: 0.4.23
published over 3 years ago

Versions: 35
Dependent Packages: 0
Dependent Repositories: 1

Rankings

Dependent repos count: 24.4%

Forks count: 42.7%

Average: 43.2%

Dependent packages count: 51.6%

Stargazers count: 54.3%

Last synced: 9 months ago

Dependencies

.github/workflows/ci.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite
actions/upload-artifact v1 composite
pypa/gh-action-pypi-publish v1.4.2 composite

setup.py pypi

pyproject.toml pypi

scikit-hep-testdata

Science Score: 36.0%

Keywords

Keywords from Contributors

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

scikit-hep-testdata

Installing and usage

Remote vs. Local files

Command-line invocation

Print a path (download if needed)

Show all "local" files

Download all files to an existing directory

Adding new files

List of files

Files stored in this package

Known remote files

Contributors

Acknowledgements

Running the tests

Owner

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: scikit-hep-testdata

Rankings

Maintainers (4)

conda-forge.org: scikit-hep-testdata

Rankings

Dependencies