yieldplotlib.plots.hz_completeness

yieldplotlib.plots.hz_completeness#

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

Functions#

plot_hz_completeness(exosims_dir, ayo_dir[, ...])

Generate a scatter plot of the habitable zone completeness.

Module Contents#

yieldplotlib.plots.hz_completeness.plot_hz_completeness(exosims_dir, ayo_dir, ax_kwargs=None, hline_kwargs=None, use_cyberpunk=False)[source]#

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.