Skip to content

Commit 6d37dc7

Browse files
committed
Update README
1 parent ae31a80 commit 6d37dc7

File tree

2 files changed

+47
-2
lines changed

2 files changed

+47
-2
lines changed

README.md

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,47 @@
11
# rundec-python
2-
Python wrapper around CRunDec
2+
3+
`CRunDec` is "a C++ program for the running and decoupling of the strong coupling constant and quark masses", developed by Florian Herren and Matthias Steinhauser. Relevant references:
4+
5+
- Version 3 of RunDec and CRunDec
6+
By Florian Herren, Matthias Steinhauser
7+
[arXiv:1703.03751](https://arxiv.org/abs/1703.03751)
8+
- CRunDec: a C++ package for running and decoupling of the strong coupling and quark masses
9+
By Barbara Schmidt, Matthias Steinhauser
10+
[arXiv:1201.6149](https://arxiv.org/abs/1201.6149)
11+
- RunDec: A Mathematica package for running and decoupling of the strong coupling and quark masses
12+
By K.G. Chetyrkin, Johann H. Kühn, M. Steinhauser
13+
[arXiv:hep-ph/0004189](https://arxiv.org/abs/hep-ph/0004189)
14+
15+
[Source code of CRunDec 3.0](https://www.ttp.kit.edu/preprints/2017/ttp17-011)
16+
17+
`rundec-python` is a Python package providing a thin wrapper around `CRunDec`.
18+
19+
## Installation
20+
21+
```bash
22+
pip install rundec
23+
```
24+
25+
## Usage
26+
27+
The API is analogous to `CRunDec`, see [the documentation](https://arxiv.org/abs/1703.03751).
28+
29+
```python
30+
import rundec
31+
32+
crd = rundec.CRunDec
33+
34+
# compute alpha_s at the b quark mass scale with 3-loop accuracy
35+
crd.AlphasExact(0.1185, 91.1876, 4.18, 5, 3)
36+
37+
# compute the b quark pole mass using the 2-loop conversion from the MSbar mass
38+
crd.mMS2mOS(4.18, None, 0.26, 4.18, 5, 2)
39+
```
40+
41+
## Technical details
42+
43+
The wrapper was generated with [SWIG](http://www.swig.org/).
44+
45+
Binary wheels are provided via [PyPI](https://pypi.python.org/pypi/rundec) for Linux and Mac OS (built on [Travis CI](https://travis-ci.org/)) and for Windows (built on [AppVeyor](https://www.appveyor.com/)).
46+
47+
The Windows wheels require Python 3.5+, on Linux and Mac OS Python 2.7+ is sufficient.

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
)
66

77
setup(name="rundec",
8-
version="0.0.1",
8+
version="0.1",
99
author="David M. Straub",
1010
author_email="david.straub@tum.de",
1111
url="https://github.com/DavidMStraub/rundec-python",

0 commit comments

Comments
 (0)