Skip to content

Commit

Permalink
Improve docstring of corrdict
Browse files Browse the repository at this point in the history
  • Loading branch information
dafeda committed Nov 30, 2024
1 parent 864228e commit 6027739
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion src/semeio/fmudesign/create_design.py
Original file line number Diff line number Diff line change
Expand Up @@ -722,7 +722,10 @@ def generate(self, realnums, parameters, seedvalues, corrdict, rng):
realnums (list): list of integers with realization numbers
parameters (OrderedDict): dictionary of parameters and distributions
seeds (str): default or None
corrdict(OrderedDict): correlation info
corrdict (OrderedDict): Configuration for correlated parameters. Contains:
- 'inputfile': Path to Excel file with correlation matrices
- 'sheetnames': List of sheet names, where each sheet contains a correlation matrix
If None, parameters are treated as uncorrelated.
"""
self.sensvalues = pd.DataFrame(columns=parameters.keys(), index=realnums)
numreals = len(realnums)
Expand Down

0 comments on commit 6027739

Please sign in to comment.