gwm17/catima
1
0
Fork 0
mirror of https://github.com/gwm17/catima.git synced 2025-01-30 17:58:49 -05:00
Code Issues Projects Releases Wiki Activity

minor docs

Browse Source
This commit is contained in:
hrocho 2021-06-22 00:47:38 +02:00
parent 9b27d008bc
commit 96a03ffc22
3 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -32,6 +32,13 @@ This can be done sourcing the init.sh file, which is generated in the build dire
> source init.sh > 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 cmake options
------------- -------------
compile options, enable or disable with cmake: compile options, enable or disable with cmake:

6
docs/README.md
View File

@ -18,6 +18,12 @@ This can be done sourcing the init.sh file, which is generated in the build dire
source init.sh source init.sh
``` ```
Python Module
-------------
Python module can be installed also using pip:
```
pip install pycatima
```
cmake options cmake options
------------- -------------

10
docs/pycatima.md
View File

@ -1,5 +1,13 @@
Usage 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 Pojectile
--------- ---------
@ -158,7 +166,7 @@ __Results__ class stores results for 1 layer of __Material__. It has following v
* dEdxo - Stopping power at exit * dEdxo - Stopping power at exit
* range - range in the material in g/cm^2 * range - range in the material in g/cm^2
* sigma_E - Energy straggling in MeV/u * 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_r - range straggling in g/cm^2
* sigma_x - position straggling in cm * sigma_x - position straggling in cm
* sp - non-reaction probability * sp - non-reaction probability