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

docs extended

Browse source
This commit is contained in:
Fabian Joswig 2021-11-08 14:52:33 +00:00
parent 10a6780c8d
commit e5d4af68e5
1 changed files with 41 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
pyerrors/__init__.py
View file

@ -30,8 +30,49 @@ my_obs = pe.Obs([samples], ['ensemble_name'])
## Multiple ensembles/replica
Error propagation for multiple ensemblesi (Markov chains with different simulation parameters) are automatically handled.
**Example:**
```python
import pyerrors as pe
obs1 = pe.Obs([samples1], ['ensemble1'])
obs2 = pe.Obs([samples1], ['ensemble2'])
my_sum = obs1 + obs2
my_sum.details()
> Result 2.00596631e+00 +/- 0.00000000e+00 +/- 0.00000000e+00 (0.000%)
> 1500 samples in 2 ensembles:
> ensemble1: ['ensemble1']
> ensemble2: ['ensemble2']
```
`pyerrors` identifies multiple replica (independent Markov chains with identical simulation parameters) by the vertical bar `|` in the name of the dataset.
**Example:**
```python
import pyerrors as pe
obs1 = pe.Obs([samples1], ['ensemble1|r01'])
obs2 = pe.Obs([samples1], ['ensemble1|r02'])
my_sum = obs1 + obs2
my_sum.details()
> Result 2.00596631e+00 +/- 0.00000000e+00 +/- 0.00000000e+00 (0.000%)
> 1500 samples in 1 ensemble:
> ensemble1: ['ensemble1|r01', 'ensemble1|r02']
```
## Irregular Monte Carlo chains
```python
import pyerrors as pe
obs1 = pe.Obs([samples1], ['ensemble1|r01'])
obs2 = pe.Obs([samples1], ['ensemble1|r02'])
my_sum = obs1 + obs2
```
# Error propagation
Automatic differentiation, cite Alberto,