yieldplotlib.plots.hz_completeness
==================================

.. py:module:: yieldplotlib.plots.hz_completeness

.. autoapi-nested-parse::

   Plots a HZ completeness comparison between an AYO and EXOSIMS run.



Functions
---------

.. autoapisummary::

   yieldplotlib.plots.hz_completeness.plot_hz_completeness


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

.. py:function:: plot_hz_completeness(exosims_dir, ayo_dir, ax_kwargs=None, hline_kwargs=None, use_cyberpunk=False)

   Generate a scatter plot of the habitable zone completeness.

   Args:
       exosims_dir (EXOSIMSDirectory):
           EXOSIMSDirectory to plot.
       ayo_dir (AYODirectory):
           AYODirectory to plot.
       ax_kwargs (dict, optional):
           Keyword arguments to pass to ax.set().
       hline_kwargs (dict, optional):
           Keyword arguments to pass to ax.axhline().
       use_cyberpunk (bool, optional):
           Whether to use the mplcyberpunk style. Default is False.

   Returns:
       matplotlib.figure.Figure, matplotlib.axes.Axes:
           Figure and axes objects for the plot.