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: gen_correlated_data docstring improved

Browse source
This commit is contained in:
Fabian Joswig 2021-11-24 17:29:51 +00:00
parent bb6d380f9f
commit f808c2243e
1 changed files with 11 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
pyerrors/misc.py
View file

@ -40,12 +40,17 @@ def gen_correlated_data(means, cov, name, tau=0.5, samples=1000):
Parameters
----------
means -- list containing the mean value of each observable.
cov -- covariance matrix for the data to be geneated.
name -- ensemble name for the data to be geneated.
tau -- can either be a real number or a list with an entry for
every dataset.
samples -- number of samples to be generated for each observable.
means : list
list containing the mean value of each observable.
cov : numpy.ndarray
covariance matrix for the data to be generated.
name : str
ensemble name for the data to be geneated.
tau : float or list
can either be a real number or a list with an entry for
every dataset.
samples : int
number of samples to be generated for each observable.
"""
assert len(means) == cov.shape[-1]