diff --git a/README.md b/README.md index 31af661..6b48485 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,13 @@ This can be done sourcing the init.sh file, which is generated in the build dire > source init.sh ``` +Python Module +------------- +Python module can be installed for Linux and Windows and python versions 3.7-3.9 using pip: +``` +pip install pycatima +``` + cmake options ------------- compile options, enable or disable with cmake: diff --git a/docs/README.md b/docs/README.md index 0821371..071a2d8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -18,6 +18,12 @@ This can be done sourcing the init.sh file, which is generated in the build dire source init.sh ``` +Python Module +------------- +Python module can be installed also using pip: +``` +pip install pycatima +``` cmake options ------------- diff --git a/docs/pycatima.md b/docs/pycatima.md index ba4f2cf..24b9f6f 100644 --- a/docs/pycatima.md +++ b/docs/pycatima.md @@ -1,5 +1,13 @@ Usage ===== +Installation +------------ +Easiest way is to install pycatima on Linux and Windows is using pip: +``` +pip install pycatima +``` +note: python 3.7-3.9 is required + Pojectile --------- @@ -158,7 +166,7 @@ __Results__ class stores results for 1 layer of __Material__. It has following v * dEdxo - Stopping power at exit * range - range in the material in g/cm^2 * sigma_E - Energy straggling in MeV/u - * sigma_a - Angular straggling in MeV/u + * sigma_a - Angular straggling in rad * sigma_r - range straggling in g/cm^2 * sigma_x - position straggling in cm * sp - non-reaction probability