montecarlo_analysis
===================

.. py:module:: montecarlo_analysis


Functions
---------

.. autoapisummary::

   montecarlo_analysis.run_mc_analysis


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

.. py:function:: run_mc_analysis(base_config, base_data, n_cases=10, param_distributions=None)

   Run Monte Carlo uncertainty & sensitivity analysis on the UTOPIA model.

   :param base_config:
   :type base_config: dict of config parameters.
   :param base_data:
   :type base_data: dict of input data.
   :param n_cases: Number of Monte Carlo cases.
   :type n_cases: int
   :param param_distributions: Dictionary: param_name -> (scipy_dist_name, kwargs dict)
   :type param_distributions: dict
   :param Returns (not implemented yet):
   :param -------:
   :param results_df: DataFrame with all inputs and outputs for each case.
   :type results_df: pd.DataFrame
   :param sa_df: DataFrame with sensitivity analysis metrics from Monaco.
   :type sa_df: pd.DataFrame