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: documentation for input module restructured.

Browse source
This commit is contained in:
Fabian Joswig 2022-02-14 14:18:49 +00:00
parent 3a6fc810b1
commit ae60c5bb8a
2 changed files with 8 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
pyerrors/__init__.py
View file

@ -338,20 +338,18 @@ For the full API see `pyerrors.fits` for fits and `pyerrors.roots` for finding r
For the full API see `pyerrors.linalg`.
# Export data
The preferred exported file format within `pyerrors` is json.gz
The preferred exported file format within `pyerrors` is json.gz. The exact specifications of this formats will be listed here soon.
## Jackknife samples
For comparison with other analysis workflows `pyerrors` can generate jackknife samples from an `Obs` object or import jackknife samples into an `Obs` object.
See `pyerrors.obs.Obs.export_jackknife` and `pyerrors.obs.import_jackknife` for details.
# Input
`pyerrors` includes an `input` submodule in which input routines and parsers for the output of various numerical programs are contained. For details see `pyerrors.input`.
# Citing
If you use `pyerrors` for research that leads to a publication please consider citing:
- Ulli Wolff, "Monte Carlo errors with less errors". Comput.Phys.Commun. 156 (2004) 143-153, Comput.Phys.Commun. 176 (2007) 383 (erratum).
- Stefan Schaefer, Rainer Sommer, Francesco Virotta, "Critical slowing down and error analysis in lattice QCD simulations". Nucl.Phys.B 845 (2011) 93-119.
- Alberto Ramos, "Automatic differentiation for error analysis of Monte Carlo data". Comput.Phys.Commun. 238 (2019) 19-35.
- Ulli Wolff, *Monte Carlo errors with less errors*. Comput.Phys.Commun. 156 (2004) 143-153, Comput.Phys.Commun. 176 (2007) 383 (erratum).
- Stefan Schaefer, Rainer Sommer, Francesco Virotta, *Critical slowing down and error analysis in lattice QCD simulations*. Nucl.Phys.B 845 (2011) 93-119.
- Alberto Ramos, *Automatic differentiation for error analysis of Monte Carlo data*. Comput.Phys.Commun. 238 (2019) 19-35.
'''
from .obs import *
from .correlators import *

3
pyerrors/input/__init__.py
View file

@ -1,3 +1,6 @@
r'''
`pyerrors` includes an `input` submodule in which input routines and parsers for the output of various numerical programs are contained.
'''
from . import bdio
from . import hadrons
from . import json