:py:mod:`maxent_disaggregation.plot_covariances`
================================================

.. py:module:: maxent_disaggregation.plot_covariances


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


Functions
~~~~~~~~~

.. autoapisummary::

   maxent_disaggregation.plot_covariances.plot_covariances



.. py:function:: plot_covariances(samples, title=None, labels=None, save=False, filename=None)

   Plot the covariance matrix of the samples using corner plots.
   :param samples: 2D array of shape (n_samples, n_disaggregates) containing the samples to plot.
   :type samples: np.ndarray
   :param title: Title for the plot. If None, a default title is used.
   :type title: str, optional
   :param labels: Custom labels for each disaggregate. If None, defaults to "Share 1", "Share 2", etc.
   :type labels: list of str, optional
   :param save: If True, save the plot to a file specified by `filename`. Default is False.
   :type save: bool, optional
   :param filename: Path to save the plot if `save` is True.
   :type filename: str, optional

   :raises ValueError: If `save` is True and `filename` is not provided.:

   .. rubric:: Notes

   - The function uses the `corner` library to create a corner plot of the samples.