carbatpy.helpers.create_param_sets_saltelli_multi
=================================================

.. py:module:: carbatpy.helpers.create_param_sets_saltelli_multi

.. autoapi-nested-parse::

   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
----------

.. autoapisummary::

   carbatpy.helpers.create_param_sets_saltelli_multi.input_data


Functions
---------

.. autoapisummary::

   carbatpy.helpers.create_param_sets_saltelli_multi.create_saltelli_sample
   carbatpy.helpers.create_param_sets_saltelli_multi.model
   carbatpy.helpers.create_param_sets_saltelli_multi.process_task
   carbatpy.helpers.create_param_sets_saltelli_multi.call_multiprocessing


Module Contents
---------------

.. py:function:: create_saltelli_sample(dic, n)

   uses SALib to create saltelli sample

   :param dic:
               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]]
                             }
   :type dic: TYPE
   :param n: DESCRIPTION. 2 ** n in Saltelli sequence
   :type n: TYPE

   :returns: **param_values** -- DESCRIPTION. parameter set
   :rtype: TYPE


.. py:function:: model(args)

   mock model, use wished model here


.. py:function:: process_task(modl, param_values_chunk, path)

   internal function called within multiprocessing


.. py:function:: call_multiprocessing(function, param_set, path='default')

   uses multiprocessing to call function with param_set

   :param function: DESCRIPTION. function to be called in multiprocessing
   :type function: TYPE
   :param param_set: DESCRIPTION. parameter set, each row is one parameter set
   :type param_set: TYPE
   :param path: DESCRIPTION. The default is RES_DIR
   :type path: TYPE, optional

   :rtype: None.


.. py:data:: input_data