lattice/pyerrors
1
0
Fork 0
mirror of https://github.com/fjosw/pyerrors.git synced 2025-03-15 14:50:25 +01:00
Code Issues Projects Releases Packages Wiki Activity

README updated

Browse source
This commit is contained in:
Fabian Joswig 2021-10-23 17:02:50 +01:00
parent 94e3ebe7f0
commit 8aa3fba222
2 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -1,4 +1,4 @@
[![flake8](https://github.com/fjosw/pyerrors/actions/workflows/flake8.yml/badge.svg)](https://github.com/fjosw/pyerrors/actions/workflows/flake8.yml) [![CI](https://github.com/fjosw/pyerrors/actions/workflows/CI.yml/badge.svg)](https://github.com/fjosw/pyerrors/actions/workflows/CI.yml) [![](https://img.shields.io/badge/python-3.6+-blue.svg)](https://www.python.org/downloads/) [![flake8](https://github.com/fjosw/pyerrors/actions/workflows/flake8.yml/badge.svg)](https://github.com/fjosw/pyerrors/actions/workflows/flake8.yml) [![Build/Test](https://github.com/fjosw/pyerrors/actions/workflows/CI.yml/badge.svg)](https://github.com/fjosw/pyerrors/actions/workflows/CI.yml) [![](https://img.shields.io/badge/python-3.6+-blue.svg)](https://www.python.org/downloads/)
# pyerrors # pyerrors
`pyerrors` is a python package for error computation and propagation of Markov chain Monte Carlo data. `pyerrors` is a python package for error computation and propagation of Markov chain Monte Carlo data.
It is based on the **gamma method** [arXiv:hep-lat/0306017](https://arxiv.org/abs/hep-lat/0306017). Some of its features are: It is based on the **gamma method** [arXiv:hep-lat/0306017](https://arxiv.org/abs/hep-lat/0306017). Some of its features are:
@ -16,7 +16,11 @@ There exist similar implementations of gamma method error analysis suites in
## Installation ## Installation
To install the most recent release of `pyerrors` run To install the most recent release of `pyerrors` run
```bash ```bash
pip install git+https://github.com/fjosw/pyerrors.git pip install git+https://github.com/fjosw/pyerrors.git@master
```
to install the current `develop` version run
```bash
pip install git+https://github.com/fjosw/pyerrors.git@develop
``` ```
## Usage ## Usage
@ -31,6 +35,7 @@ obs1.print()
Often one is interested in secondary observables which can be arbitrary functions of primary observables. `pyerrors` overloads most basic math operations and `numpy` functions such that the user can work with `Obs` objects as if they were floats Often one is interested in secondary observables which can be arbitrary functions of primary observables. `pyerrors` overloads most basic math operations and `numpy` functions such that the user can work with `Obs` objects as if they were floats
```python ```python
import numpy as np import numpy as np
obs3 = 12.0 / obs1 ** 2 - np.exp(-1.0 / obs2) obs3 = 12.0 / obs1 ** 2 - np.exp(-1.0 / obs2)
obs3.gamma_method() obs3.gamma_method()
obs3.print() obs3.print()
@ -44,6 +49,5 @@ More detailed examples can be found in the `examples` folder:
* [04_fit_example](examples/04_fit_example.ipynb) * [04_fit_example](examples/04_fit_example.ipynb)
* [05_matrix_operations](examples/05_matrix_operations.ipynb) * [05_matrix_operations](examples/05_matrix_operations.ipynb)
## License ## License
[MIT](https://choosealicense.com/licenses/mit/) [MIT](https://choosealicense.com/licenses/mit/)

2
setup.py
View file

@ -3,7 +3,7 @@
from setuptools import setup, find_packages from setuptools import setup, find_packages
setup(name='pyerrors', setup(name='pyerrors',
version='1.1.0', version='2.0.0',
description='Error analysis for lattice QCD', description='Error analysis for lattice QCD',
author='Fabian Joswig', author='Fabian Joswig',
author_email='fabian.joswig@ed.ac.uk', author_email='fabian.joswig@ed.ac.uk',