Metadata-Version: 2.1
Name: pylandau
Version: 2.2.0
Summary: UNKNOWN
License: UNKNOWN
Keywords: Landau,Langau,PDF
Platform: any
Description-Content-Type: text/markdown
License-File: LICENSE

# pylandau
![example branch parameter](https://github.com/Silab-Bonn/pylandau/actions/workflows/tests.yml/badge.svg?branch=master)

A simple [Landau](http://en.wikipedia.org/wiki/Landau_distribution) definition to be used in Python, since no common package (Scipy, Numpy, ...) provides this. Also a fast Landau + Gauss convolution is offered, that is usefull for fitting energy losses of charged particles in matter. The Landau is approximated according to  [Computer Phys. Comm. 31 (1984) 97-111](http://dx.doi.org/10.1016/0010-4655(84)90085-7) and the implementation is from [CERN ROOT Mathlibs](https://project-mathlibs.web.cern.ch/project-mathlibs/sw/html/PdfFuncMathCore_8cxx_source.html).

## Installation
The project is hosted at [PyPI](https://pypi.org/project/pylandau). For installation just type:
```
pip install pylandau
```

If you want to change the code or start contributing download it and put it into a directory of your choice. From the project root folder run:
```
pip install -e .
```
## Usage

```python
import numpy as np
import pylandau

x = np.arange(0, 100, 0.01)
y_landau = pylandau.landau(x)
y_langau = pylandau.langau(x)
```


