carbatpy.helpers.create_param_sets_saltelli_multi

Created on Thu Aug 8 13:00:55 2024 use Saltelli-sequence to create parameter sample set within defined bounds, then calls modell including multiprocessing @author: welp

Attributes

input_data

Functions

`create_saltelli_sample`(dic, n)	uses SALib to create saltelli sample
`model`(args)	mock model, use wished model here
`process_task`(modl, param_values_chunk, path)	internal function called within multiprocessing
`call_multiprocessing`(function, param_set[, path])	uses multiprocessing to call function with param_set

Module Contents

carbatpy.helpers.create_param_sets_saltelli_multi.create_saltelli_sample(dic, n)[source]

uses SALib to create saltelli sample

Parameters:

dic (TYPE) –

DESCRIPTION. example:

{‘num_vars’: 5,
’names’: [‘dT’, ‘p_ve’, ‘p_e’, ‘xa’, ‘xb’], ‘bounds’: [[2, 25], [2, 8], [200, 600], [0.5, 0.7], [0.05, 0.29]] }
n (TYPE) – DESCRIPTION. 2 ** n in Saltelli sequence

Returns:

param_values – DESCRIPTION. parameter set

Return type:

TYPE

carbatpy.helpers.create_param_sets_saltelli_multi.model(args)[source]: mock model, use wished model here

carbatpy.helpers.create_param_sets_saltelli_multi.process_task(modl, param_values_chunk, path)[source]: internal function called within multiprocessing

carbatpy.helpers.create_param_sets_saltelli_multi.call_multiprocessing(function, param_set, path='default')[source]

uses multiprocessing to call function with param_set

Parameters:

function (TYPE) – DESCRIPTION. function to be called in multiprocessing
param_set (TYPE) – DESCRIPTION. parameter set, each row is one parameter set
path (TYPE, optional) – DESCRIPTION. The default is RES_DIR

Return type:

None.

carbatpy.helpers.create_param_sets_saltelli_multi.input_data[source]