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

Update readme

parent b0ed4e8f
No related branches found
No related tags found
No related merge requests found
Pipeline #8816 passed
......@@ -10,22 +10,30 @@ The jppy Python package
.. image:: https://examples.pages.km3net.de/km3badges/docs-latest-brightgreen.svg
:target: https://km3py.pages.km3net.de/jppy
This software provides access to the PDF functionalities in Jpp. It depends on
some Jpp headers (no Jpp compilation needed) and on the ROOT ``TMath`` (a
compiled ROOT installation is needed).
This software provides Python access to functionalities in Jpp, like accesing
PDF functions.
It currently depends on a few Jpp headers (no Jpp compilation needed) and on
ROOT ``TMath`` (a compiled ROOT installation is needed).
**Note:** Beware that this package is WIP!
**Note:** Beware that this package is in the development phase, so the API will
change until version ``1.0.0`` is released!
Installation
============
Run ``make`` to compile the Python modules::
The package can be installed via ``pip`` directly from the Git repository::
pip install git+https://git.km3net.de/km3py/jppy
or from a local clone::
git clone https://git.km3net.de/km3py/jppy
pip install jppy/
make
Example
=======
Example - Using PDFs
====================
Here is an example how to play around with muon PDFs using the ``jppy`` module::
......
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