From e2d03359011ee01a707bb1117b37834dd4aafbbb Mon Sep 17 00:00:00 2001
From: Tamas Gal <tgal@km3net.de>
Date: Sun, 19 Jul 2020 11:40:31 +0200
Subject: [PATCH] Update pip installation note
---
README.rst | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/README.rst b/README.rst
index 96152f6..ae68b19 100644
--- a/README.rst
+++ b/README.rst
@@ -17,7 +17,7 @@ purposes.
Installation and usage
----------------------
- pip install km3net_testdata
+ pip install km3net-testdata
The file paths can be access in Python scripts using the ``data_path()`` function:
@@ -27,6 +27,9 @@ The file paths can be access in Python scripts using the ``data_path()`` functio
filename = data_path("km3net_offline.root")
+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
print the filepath:
--
GitLab