Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
K
KM3NeT TestData
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
km3py
KM3NeT TestData
Commits
16cc110d
Commit
16cc110d
authored
2 years ago
by
Tamas Gal
Browse files
Options
Downloads
Plain Diff
Merge branch 'readme-update' into 'master'
Update readme See merge request
!32
parents
85277bd8
532af5d5
No related branches found
Branches containing commit
No related tags found
Tags containing commit
1 merge request
!32
Update readme
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.rst
+28
-2
28 additions, 2 deletions
README.rst
with
28 additions
and
2 deletions
README.rst
+
28
−
2
View file @
16cc110d
...
...
@@ -11,12 +11,15 @@ 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.
Installation and usage
----------------------
Python
``````
pip install km3net-testdata
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
Notice the underscore in the Python package name (PyPI forces ``-`` but Python
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:
.. code-block:: shell
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment