Add a better docstring to read_ms5_xsf method

This commit is contained in:
jkuhl-uni 2022-12-20 13:44:07 +01:00
parent f74793b765
commit ae62548661

View file

@ -988,7 +988,25 @@ def read_qtop_sector(path, prefix, c, target=0, **kwargs):
def read_ms5_xsf(path, prefix, qc, corr): def read_ms5_xsf(path, prefix, qc, corr):
"""
Read and process data from files with a specific prefix and containing the given quark combination in the file name.
Parameters
----------
path : str
The path to the directory containing the data files.
prefix : str
The prefix of the data files to be processed.
qc : str
The quark combination to be used to filter the data files.
corr : str
The correlator to be extracted from the data files.
Returns
-------
list of list of float
A list of lists containing the real and imaginary parts of the specified correlator for each configuration.
"""
found = [] found = []
files = [] files = []
for (dirpath, dirnames, filenames) in os.walk(path + "/"): for (dirpath, dirnames, filenames) in os.walk(path + "/"):