tilupy.compare
==============

.. py:module:: tilupy.compare

.. autoapi-nested-parse::

   Created on Wed Jun  2 17:57:31 2021

   @author: peruzzetto




Functions
---------

.. autoapisummary::

   tilupy.compare.compare_spatial_results
   tilupy.compare.compare_simus



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


Functions
^^^^^^^^^

.. py:function:: compare_spatial_results(results, name, stat, import_kwargs=None, x=None, y=None, zinit=None, nrows_ncols=None, figsize=None, folder_out=None, file_prefix=None, fmt='png', dpi=150, cbar_location='bottom', cbar_size='5%', cmap_intervals=None, cmap='inferno', topo_kwargs=None, title_loc='top right', title_x_offset=0.02, title_y_offset=0.02)

   Compare spatiale results of different simulations

   :param results: DESCRIPTION.
   :type results: TYPE
   :param name: DESCRIPTION.
   :type name: TYPE
   :param import_kwargs: DESCRIPTION. The default is None.
   :type import_kwargs: TYPE, optional
   :param x: DESCRIPTION. The default is None.
   :type x: TYPE, optional
   :param y: DESCRIPTION. The default is None.
   :type y: TYPE, optional
   :param zinit: DESCRIPTION. The default is None.
   :type zinit: TYPE, optional
   :param figsize: DESCRIPTION. The default is None.
   :type figsize: TYPE, optional
   :param folder_out: DESCRIPTION. The default is None.
   :type folder_out: TYPE, optional
   :param cbar_location: DESCRIPTION. The default is 'bottom'.
   :type cbar_location: TYPE, optional
   :param cbar_size: DESCRIPTION. The default is "5%".
   :type cbar_size: TYPE, optional
   :param cmap_intervals: DESCRIPTION. The default is None.
   :type cmap_intervals: TYPE, optional
   :param cmap: DESCRIPTION. The default is 'inferno'.
   :type cmap: TYPE, optional
   :param topo_kwargs: DESCRIPTION. The default is None.
   :type topo_kwargs: TYPE, optional

   :rtype: None.


.. py:function:: compare_simus(codes, topo_name, law, rheol_params, output_name, stat_name, subfolder_topo='', folder_benchmark=None, folder_out=None, **kwargs)

   Compare simulations with different codes.