{ "info": { "author": "Ben Krikler", "author_email": "b.krikler@cern.ch", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Natural Language :: English", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "[![PyPI version](https://img.shields.io/pypi/v/scikit-hep-testdata.svg?longCache=true)](https://pypi.org/project/scikit-hep-testdata/)\n[![Build Status](https://travis-ci.com/scikit-hep/scikit-hep-testdata.svg?branch=master)](https://travis-ci.com/scikit-hep/scikit-hep-testdata)\n[![codecov](https://img.shields.io/codecov/c/github/scikit-hep/scikit-hep-testdata/master.svg?longCache=true)](https://codecov.io/gh/scikit-hep/scikit-hep-testdata)\n\nscikit-hep-testdata\n===================\n\nA common package to provide example files (*e.g*. ROOT) for testing and developing packages against.\nThe sample of files is representative of typical files found \"in the wild\".\n\nIn addition to including some root files directly, this package adds some simple helper methods to\nget larger files from common open-access data repositories.\n\n## Installing and usage\nTo install:\n```bash\npip install scikit-hep-testdata\n```\n\nOnce installed, absolute file paths can be resolved using the helper methods:\n``` python\nfrom skhep_testdata import data_path\n\nfilename = data_path(\"some_file.root\")\n```\nBy default, if an unknown file is requested an exception is raised but this can be skipped by passing the above method `raise_missing=False`:\n```python\nfilename = data_path(\"unknown_file.root\", raise_missing=False)\n```\n\n### Remote vs. Local files\nSome files, particularly large ones, for example, are not stored within this package and instead live on a remote server; we call these \"remote files\".\nTo obtain these use the same `data_path` method as above, however this will trigger the code to download and configure the remote file. \nThis might be slow the first time round but will subsequently be as fast as for a local file.\n\n### Command-line invocation\nYou can also interact with this package from the command-line:\n```bash\npython -m skhep_testdata cms_hep_2012_tutorial/data.root\n```\n\n## Adding new files\nWe're on the look out for new, interesting files!\n- *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.\n- *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.\n\n## List of files\nThe following lists describe the files known by this package.\n\n### Files stored in this package\n-\n\n### Known remote files\n- [CMS HEP public tutorial from 2012](http://opendata.cern.ch/record/50)\n\n## Acknowledgements\n- Many of the files collected directly within this package were collated originally by Jim Pivarski for [uproot](https://github.com/scikit-hep/uproot)\n\n## Running the tests\nThis package uses `pytest` to run the unit tests.\n```bash\npytest -vv tests/\n```\n\nUse the pytest-cov plugin to get a report on the test coverage:\n\n```bash\npytest --cov=skhep_testdata --cov-report=html -vv tests/\n```", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/scikit-hep/scikit-hep-testdata", "keywords": "ROOT,HEP,testing", "license": "BSD 3-clause", "maintainer": "", "maintainer_email": "", "name": "scikit-hep-testdata", "package_url": "https://pypi.org/project/scikit-hep-testdata/", "platform": "", "project_url": "https://pypi.org/project/scikit-hep-testdata/", "project_urls": { "Homepage": "https://github.com/scikit-hep/scikit-hep-testdata" }, "release_url": "https://pypi.org/project/scikit-hep-testdata/0.1.3/", "requires_dist": null, "requires_python": "", "summary": "Example HEP files for testing and demonstrating", "version": "0.1.3" }, "last_serial": 4879866, "releases": { "0.1.1": [ { "comment_text": "", "digests": { "md5": "ca0ae6ad7fa67635c1db75028d16a5ff", "sha256": "7483709e6dc15864735217fc196a2eec8e11c7da03600852d99a8e6b419deda4" }, "downloads": -1, "filename": "scikit-hep-testdata-0.1.1.tar.gz", "has_sig": false, "md5_digest": "ca0ae6ad7fa67635c1db75028d16a5ff", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 54242436, "upload_time": "2019-02-26T11:17:56", "url": "https://files.pythonhosted.org/packages/47/ad/d430f5ba1e321d2dabae5637ba05e51cedc64eb462f937d08a385a56111f/scikit-hep-testdata-0.1.1.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "9ef1c6c643a536e5d308bfbe51e14452", "sha256": "2e6bd537f00e007b620217fa434dc90bce678cabe18645d5310f44c56817ee03" }, "downloads": -1, "filename": "scikit-hep-testdata-0.1.3.tar.gz", "has_sig": false, "md5_digest": "9ef1c6c643a536e5d308bfbe51e14452", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 56567678, "upload_time": "2019-02-28T15:51:48", "url": "https://files.pythonhosted.org/packages/75/2c/173f7ff0b86ce4cdccb593da6783c8e84f8e340b405fefd47b2bbc03a477/scikit-hep-testdata-0.1.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9ef1c6c643a536e5d308bfbe51e14452", "sha256": "2e6bd537f00e007b620217fa434dc90bce678cabe18645d5310f44c56817ee03" }, "downloads": -1, "filename": "scikit-hep-testdata-0.1.3.tar.gz", "has_sig": false, "md5_digest": "9ef1c6c643a536e5d308bfbe51e14452", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 56567678, "upload_time": "2019-02-28T15:51:48", "url": "https://files.pythonhosted.org/packages/75/2c/173f7ff0b86ce4cdccb593da6783c8e84f8e340b405fefd47b2bbc03a477/scikit-hep-testdata-0.1.3.tar.gz" } ] }