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

Merge branch 'readme-update' into 'master'

Update readme

See merge request !32
parents 85277bd8 532af5d5
No related branches found
No related tags found
1 merge request!32Update readme
...@@ -11,12 +11,15 @@ KM3NeT TestData ...@@ -11,12 +11,15 @@ KM3NeT TestData
:target: https://km3py.pages.km3net.de/km3net-testdata :target: https://km3py.pages.km3net.de/km3net-testdata
A package to get access to KM3NeT sample files for testing and development A hybrid Python/Julia package to get access to KM3NeT sample files for testing and development
purposes. purposes.
Installation and usage Installation and usage
---------------------- ----------------------
Python
``````
pip install km3net-testdata pip install km3net-testdata
The file paths can be access in Python scripts using the ``data_path()`` function: The file paths can be access in Python scripts using the ``data_path()`` function:
...@@ -30,7 +33,30 @@ The file paths can be access in Python scripts using the ``data_path()`` functio ...@@ -30,7 +33,30 @@ The file paths can be access in Python scripts using the ``data_path()`` functio
Notice the underscore in the Python package name (PyPI forces ``-`` but Python Notice the underscore in the Python package name (PyPI forces ``-`` but Python
package names are not allowed to use ``-``). package names are not allowed to use ``-``).
To use the module in e.g. shell scripts, the module can be called directly and 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: print the filepath:
.. code-block:: shell .. code-block:: shell
......
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