mirror of
https://github.com/fjosw/pyerrors.git
synced 2025-03-15 14:50:25 +01:00
README shortened, python badge added
This commit is contained in:
parent
a5f9583229
commit
1ad4f798e4
1 changed files with 1 additions and 8 deletions
|
@ -1,4 +1,4 @@
|
|||
[](https://github.com/fjosw/pyerrors/actions/workflows/flake8.yml) [](https://github.com/fjosw/pyerrors/actions/workflows/CI.yml)
|
||||
[](https://github.com/fjosw/pyerrors/actions/workflows/flake8.yml) [](https://github.com/fjosw/pyerrors/actions/workflows/CI.yml)[]
|
||||
# pyerrors
|
||||
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:
|
||||
|
@ -16,18 +16,11 @@ There exist similar implementations of gamma method error analysis suites in
|
|||
- [Python 3](https://github.com/mbruno46/pyobs)
|
||||
|
||||
## Installation
|
||||
pyerrors requires python versions >= 3.5.0
|
||||
|
||||
Install the package for the local user:
|
||||
```bash
|
||||
pip install . --user
|
||||
```
|
||||
|
||||
Run tests to verify the installation:
|
||||
```bash
|
||||
pytest .
|
||||
```
|
||||
|
||||
## Usage
|
||||
The basic objects of a pyerrors analysis are instances of the class `Obs`. They can be initialized with an array of Monte Carlo data (e.g. `samples1`) and a name for the given ensemble (e.g. `'ensemble1'`). The `gamma_method` can then be used to compute the statistical error, taking into account autocorrelations. The `print` method outputs a human readable result.
|
||||
```python
|
||||
|
|
Loading…
Add table
Reference in a new issue