mirror of
https://github.com/fjosw/pyerrors.git
synced 2025-03-15 23:00:25 +01:00
docs: docstrings in input.hadrons updated
This commit is contained in:
parent
2b33d79674
commit
4ecbe2f8f2
1 changed files with 21 additions and 12 deletions
|
@ -134,10 +134,13 @@ def read_ExternalLeg_hd5(path, filestem, ens_id, idl=None):
|
||||||
"""Read hadrons ExternalLeg hdf5 file and output an array of CObs
|
"""Read hadrons ExternalLeg hdf5 file and output an array of CObs
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
-----------------
|
----------
|
||||||
path -- path to the files to read
|
path : str
|
||||||
filestem -- namestem of the files to read
|
path to the files to read
|
||||||
ens_id -- name of the ensemble, required for internal bookkeeping
|
filestem : str
|
||||||
|
namestem of the files to read
|
||||||
|
ens_id : str
|
||||||
|
name of the ensemble, required for internal bookkeeping
|
||||||
idl : range
|
idl : range
|
||||||
If specified only configurations in the given range are read in.
|
If specified only configurations in the given range are read in.
|
||||||
"""
|
"""
|
||||||
|
@ -171,10 +174,13 @@ def read_Bilinear_hd5(path, filestem, ens_id, idl=None):
|
||||||
"""Read hadrons Bilinear hdf5 file and output an array of CObs
|
"""Read hadrons Bilinear hdf5 file and output an array of CObs
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
-----------------
|
----------
|
||||||
path -- path to the files to read
|
path : str
|
||||||
filestem -- namestem of the files to read
|
path to the files to read
|
||||||
ens_id -- name of the ensemble, required for internal bookkeeping
|
filestem : str
|
||||||
|
namestem of the files to read
|
||||||
|
ens_id : str
|
||||||
|
name of the ensemble, required for internal bookkeeping
|
||||||
idl : range
|
idl : range
|
||||||
If specified only configurations in the given range are read in.
|
If specified only configurations in the given range are read in.
|
||||||
"""
|
"""
|
||||||
|
@ -222,10 +228,13 @@ def read_Fourquark_hd5(path, filestem, ens_id, idl=None):
|
||||||
"""Read hadrons FourquarkFullyConnected hdf5 file and output an array of CObs
|
"""Read hadrons FourquarkFullyConnected hdf5 file and output an array of CObs
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
-----------------
|
----------
|
||||||
path -- path to the files to read
|
path : str
|
||||||
filestem -- namestem of the files to read
|
path to the files to read
|
||||||
ens_id -- name of the ensemble, required for internal bookkeeping
|
filestem : str
|
||||||
|
namestem of the files to read
|
||||||
|
ens_id : str
|
||||||
|
name of the ensemble, required for internal bookkeeping
|
||||||
idl : range
|
idl : range
|
||||||
If specified only configurations in the given range are read in.
|
If specified only configurations in the given range are read in.
|
||||||
"""
|
"""
|
||||||
|
|
Loading…
Add table
Reference in a new issue