diff --git a/examples/plot_calculator.py b/examples/plot_calculator.py deleted file mode 100644 index 5ccf7e1bf8cd5130beb8e5921feac51bbc97ed08..0000000000000000000000000000000000000000 --- a/examples/plot_calculator.py +++ /dev/null @@ -1,22 +0,0 @@ -""" -How to use the Calculator -========================= - -The following example shows how to use the `Calculator` class. -""" -from km3net_testdata import Calculator - -##################################################### -# Initialising a Calculator -# ------------------------- -# Initialising is a simple as this: - -calc = Calculator() - -##################################################### -# Adding numbers -# ~~~~~~~~~~~~~~ -# -# You can add two numbers by calling the `.add(a, b)` method: - -print(calc.add(5, 23)) diff --git a/examples/plot_usage.py b/examples/plot_usage.py new file mode 100644 index 0000000000000000000000000000000000000000..b6a93d49cdb1d78d943e5c647ada975308b2c7ab --- /dev/null +++ b/examples/plot_usage.py @@ -0,0 +1,15 @@ +""" +How to use the package +======================= + +The following example shows how to use the `Calculator` class. +""" +from km3net_testdata import data_path + +##################################################### +# Getting a filename +# ------------------ +# To get the filename of a sample file: + +filename = data_path("km3net_online.root") +print(filename)