:py:mod:`src.graphic_interface.simu_result`
===========================================

.. py:module:: src.graphic_interface.simu_result


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

Classes
~~~~~~~

.. autoapisummary::

   src.graphic_interface.simu_result.Simu_result



Functions
~~~~~~~~~

.. autoapisummary::

   src.graphic_interface.simu_result.load_all_simulation



.. py:class:: Simu_result(path)

   A class to easily handle results of simulations

   :param path: path to a folder with a config.ini file and `scipy.optimize.OptimizeResult` object in a file named *result*
   :type path: String
   :raises Exception: unable to find the folder with right files

   .. py:method:: get_data_dic(self, surf_param=None)

      get the different costs of the results of the simulation

      :param surf_param: surface to use, if None, use the last one of the simulation
      :type surf_param: 1D array

      :rtype: dictionary


   .. py:method:: get_data_dic_ref(self)

      get the different costs of the surface used to initialize the optimization

      :rtype: dictionary



.. py:function:: load_all_simulation(path)

   Load all the folder in a given path

   :type path: String
   :rtype: list :class:`Simu_result`