Skip to content
Snippets Groups Projects
Commit 7ebaefe1 authored by Tamas Gal's avatar Tamas Gal :speech_balloon:
Browse files

Update readme

parent 52b15970
No related branches found
No related tags found
No related merge requests found
Pipeline #12960 failed
......@@ -10,3 +10,25 @@ KM3NeT TestData
.. image:: https://examples.pages.km3net.de/km3badges/docs-latest-brightgreen.svg
:target: https://km3py.pages.km3net.de/km3net_testdata
A package to get access to KM3NeT sample files for testing and development
purposes.
Installation and usage
----------------------
pip install km3net_testdata
The file paths can be access in Python scripts using the ``data_path()`` function:
.. code-block:: python
from km3net_testdata import data_path()
filename = data_path("km3net_offline.root")
Acknowledgements
----------------
The project idea and implementation were inspired by the Scikit-HEP Project https://github.com/scikit-hep/scikit-hep-testdata
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment