From ae60c5bb8a0f024255edbfaf6e52319e96ded6ff Mon Sep 17 00:00:00 2001 From: Fabian Joswig Date: Mon, 14 Feb 2022 14:18:49 +0000 Subject: [PATCH] docs: documentation for input module restructured. --- pyerrors/__init__.py | 12 +++++------- pyerrors/input/__init__.py | 3 +++ 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/pyerrors/__init__.py b/pyerrors/__init__.py index 266a7d43..a87eb9b7 100644 --- a/pyerrors/__init__.py +++ b/pyerrors/__init__.py @@ -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 * diff --git a/pyerrors/input/__init__.py b/pyerrors/input/__init__.py index 2797841c..735de0c3 100644 --- a/pyerrors/input/__init__.py +++ b/pyerrors/input/__init__.py @@ -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