lattice/pyerrors
1
0
Fork 0
mirror of https://github.com/fjosw/pyerrors.git synced 2025-05-15 12:03:42 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: docstring of read_sfcf extended.

Browse source
This commit is contained in:
Fabian Joswig 2022-11-18 15:35:30 +00:00
parent e6a84678bb
commit c4ca0faaa6
No known key found for this signature in database
1 changed files with 16 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

14
pyerrors/input/sfcf.py
View file

@ -11,11 +11,22 @@ def read_sfcf(path, prefix, name, quarks='.*', corr_type='bi', noffset=0, wf=0,
Parameters Parameters
---------- ----------
path : str
Path to the sfcf files.
prefix : str
Prefix of the sfcf files.
name : str
Name of the correlation function to read.
quarks : str quarks : str
Label of the quarks used in the sfcf input file. e.g. "quark quark" Label of the quarks used in the sfcf input file. e.g. "quark quark"
for version 0.0 this does NOT need to be given with the typical " - " for version 0.0 this does NOT need to be given with the typical " - "
that is present in the output file, that is present in the output file,
this is done automatically for this version this is done automatically for this version
corr_type : str
Type of correlation function to read. Can be
- 'bi' for boundary-inner
- 'bb' for boundary-boundary
- 'bib' for boundary-inner-boundary
noffset : int noffset : int
Offset of the source (only relevant when wavefunctions are used) Offset of the source (only relevant when wavefunctions are used)
wf : int wf : int
@ -26,9 +37,6 @@ def read_sfcf(path, prefix, name, quarks='.*', corr_type='bi', noffset=0, wf=0,
im : bool im : bool
if True, read imaginary instead of real part if True, read imaginary instead of real part
of the correlation function. of the correlation function.
corr_type : str
change between bi (boundary - inner) (default) bib (boundary - inner - boundary) and bb (boundary - boundary)
correlator types
names : list names : list
Alternative labeling for replicas/ensembles. Alternative labeling for replicas/ensembles.
Has to have the appropriate length Has to have the appropriate length