From 602773967c0d74a01bcdb4972f6c1026cc79e917 Mon Sep 17 00:00:00 2001 From: Feda Curic Date: Sat, 30 Nov 2024 11:12:46 +0100 Subject: [PATCH] Improve docstring of corrdict --- src/semeio/fmudesign/create_design.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/semeio/fmudesign/create_design.py b/src/semeio/fmudesign/create_design.py index b3327380..77f48e01 100644 --- a/src/semeio/fmudesign/create_design.py +++ b/src/semeio/fmudesign/create_design.py @@ -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)