:py:mod:`BioSANS2020.propagation.propensity`
============================================

.. py:module:: BioSANS2020.propagation.propensity

.. autoapi-nested-parse::

                        This is the propensity module

   This module prepares the propensity vector or fluxes vector




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


Functions
~~~~~~~~~

.. autoapisummary::

   BioSANS2020.propagation.propensity.propensity_vec
   BioSANS2020.propagation.propensity.propensity_vec_molar



.. py:function:: propensity_vec(ks_dict, conc, r_dict, p_dict, odeint=False)

   Returns propensity vector using microscopic equations

   Args:
       ks_dict (dict): check details in process module
       conc (dict): check details in process module
       r_dict (dict): check details in process module
       p_dict (dict): check details in process module
       odeint (bool, optional): [description]. Defaults to False.

   Returns:
       np.ndarray: propensity vector


.. py:function:: propensity_vec_molar(ks_dict, conc, r_dict, p_dict, odeint=False)

   Returns propensity vector using macroscopic equations

   Args:
       ks_dict (dict): check details in process module
       conc (dict): check details in process module
       r_dict (dict): check details in process module
       p_dict (dict): check details in process module
       odeint (bool, optional): [description]. Defaults to False.

   Returns:
       np.ndarray: propensity vector