KM3NeT TestData
===============
.. image:: https://git.km3net.de/km3py/km3net-testdata/badges/master/pipeline.svg
:target: https://git.km3net.de/km3py/km3net-testdata/pipelines
.. image:: https://git.km3net.de/km3py/km3net-testdata/badges/master/coverage.svg
:target: https://km3py.pages.km3net.de/km3net-testdata/coverage
.. image:: https://git.km3net.de/examples/km3badges/-/raw/master/docs-latest-brightgreen.svg
:target: https://km3py.pages.km3net.de/km3net-testdata
A hybrid Python/Julia package to get access to KM3NeT sample files for testing and development
purposes.
Installation and usage
----------------------
Python
``````
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("offline/km3net_offline.root")
Notice the underscore in the Python package name (PyPI forces ``-`` but Python
package names are not allowed to use ``-``).
Julia
`````
Make sure the "KM3NeT Julia Registry" is added to your local Julia registries,
see https://git.km3net.de/common/julia-registry for more information.
The Julia package is called ``KM3NeTTestData`` and can be installed the usual way:
.. code-block:: julia
julia> import Pkg; Pkg.add("KM3NeTTestData")
The package exports the ``datapath()`` function which can be used similar to the Python implementation:
.. code-block:: julia
julia> using KM3NeTTestData
julia> filename = datapath("offline", "km3net_offline.root")
"/Users/tamasgal/.julia/packages/KM3NeTTestData/zb9oT/src/../km3net_testdata/data/offline/km3net_offline.root"
Shell
`````
To use the Python module in e.g. shell scripts, it can be called directly to
print the filepath:
.. code-block:: shell
$ python -m km3net_testdata offline/km3net_offline.root
/full/path/to/offline/km3net_offline.root
It can be combined with other shell tools, as usual:
.. code-block:: shell
$ head -n 5 $(python -m km3net_testdata detx/detx_v3.detx)
# a comment line
# another comment line starting with '#'
23 v3
1500000000.1 9999999999.0
UTM WGS84 32N 256500.0 4743000.0 -2425.0
Acknowledgements
----------------
The project idea and implementation were inspired by the Scikit-HEP Project https://github.com/scikit-hep/scikit-hep-testdata
Raw data
{
"_id": null,
"home_page": "https://git.km3net.de/km3py/km3net-testdata",
"name": "km3net-testdata",
"maintainer": null,
"docs_url": null,
"requires_python": ">=2.7",
"maintainer_email": null,
"keywords": null,
"author": "Tamas Gal",
"author_email": "tgal@km3net.de",
"download_url": "https://files.pythonhosted.org/packages/aa/19/92554b8475cda65907275f14c5b9d8fa82d12e13369b42234c4a1d2df444/km3net_testdata-0.4.17.tar.gz",
"platform": "any",
"description": "KM3NeT TestData\n===============\n\n.. image:: https://git.km3net.de/km3py/km3net-testdata/badges/master/pipeline.svg\n :target: https://git.km3net.de/km3py/km3net-testdata/pipelines\n\n.. image:: https://git.km3net.de/km3py/km3net-testdata/badges/master/coverage.svg\n :target: https://km3py.pages.km3net.de/km3net-testdata/coverage\n\n.. image:: https://git.km3net.de/examples/km3badges/-/raw/master/docs-latest-brightgreen.svg\n :target: https://km3py.pages.km3net.de/km3net-testdata\n\n\nA hybrid Python/Julia package to get access to KM3NeT sample files for testing and development\npurposes.\n\nInstallation and usage\n----------------------\n\nPython\n``````\n\n pip install km3net-testdata\n\nThe file paths can be access in Python scripts using the ``data_path()`` function:\n\n.. code-block:: python\n\n from km3net_testdata import data_path\n\n filename = data_path(\"offline/km3net_offline.root\")\n\nNotice the underscore in the Python package name (PyPI forces ``-`` but Python\npackage names are not allowed to use ``-``).\n\nJulia\n`````\n\nMake sure the \"KM3NeT Julia Registry\" is added to your local Julia registries,\nsee https://git.km3net.de/common/julia-registry for more information.\nThe Julia package is called ``KM3NeTTestData`` and can be installed the usual way:\n\n.. code-block:: julia\n\n julia> import Pkg; Pkg.add(\"KM3NeTTestData\")\n\nThe package exports the ``datapath()`` function which can be used similar to the Python implementation:\n\n.. code-block:: julia\n\n julia> using KM3NeTTestData\n\n julia> filename = datapath(\"offline\", \"km3net_offline.root\")\n \"/Users/tamasgal/.julia/packages/KM3NeTTestData/zb9oT/src/../km3net_testdata/data/offline/km3net_offline.root\"\n\nShell\n`````\n\nTo use the Python module in e.g. shell scripts, it can be called directly to\nprint the filepath:\n\n.. code-block:: shell\n\n $ python -m km3net_testdata offline/km3net_offline.root\n /full/path/to/offline/km3net_offline.root\n\nIt can be combined with other shell tools, as usual:\n\n.. code-block:: shell\n\n $ head -n 5 $(python -m km3net_testdata detx/detx_v3.detx)\n # a comment line\n # another comment line starting with '#'\n 23 v3\n 1500000000.1 9999999999.0\n UTM WGS84 32N 256500.0 4743000.0 -2425.0\n\nAcknowledgements\n----------------\n\nThe project idea and implementation were inspired by the Scikit-HEP Project https://github.com/scikit-hep/scikit-hep-testdata\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "KM3NeT TestData",
"version": "0.4.17",
"project_urls": {
"Homepage": "https://git.km3net.de/km3py/km3net-testdata"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a12fe1dbd9acd874637641709455bfa8f19d9946cbed017d8621bd708764a800",
"md5": "5a6b8cc464205291cd9a5cee625922bc",
"sha256": "1c7fc7b1183fc9be022c248eabff5563b66ae676ae592b55cef3e362a6aaf840"
},
"downloads": -1,
"filename": "km3net_testdata-0.4.17-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5a6b8cc464205291cd9a5cee625922bc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=2.7",
"size": 68594533,
"upload_time": "2024-11-07T19:02:32",
"upload_time_iso_8601": "2024-11-07T19:02:32.144476Z",
"url": "https://files.pythonhosted.org/packages/a1/2f/e1dbd9acd874637641709455bfa8f19d9946cbed017d8621bd708764a800/km3net_testdata-0.4.17-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "aa1992554b8475cda65907275f14c5b9d8fa82d12e13369b42234c4a1d2df444",
"md5": "b1742ad2dc1bd21a6c7799013e4346ed",
"sha256": "0b899919b18b19339098cc7baf584bd68fca1b0f842691c51d5a372ec1f401ea"
},
"downloads": -1,
"filename": "km3net_testdata-0.4.17.tar.gz",
"has_sig": false,
"md5_digest": "b1742ad2dc1bd21a6c7799013e4346ed",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7",
"size": 68442384,
"upload_time": "2024-11-07T19:02:39",
"upload_time_iso_8601": "2024-11-07T19:02:39.700778Z",
"url": "https://files.pythonhosted.org/packages/aa/19/92554b8475cda65907275f14c5b9d8fa82d12e13369b42234c4a1d2df444/km3net_testdata-0.4.17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-07 19:02:39",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "km3net-testdata"
}
JSON