aerosandbox.tools.pretty_plots.plots.contour
============================================

.. py:module:: aerosandbox.tools.pretty_plots.plots.contour


Attributes
----------

.. autoapisummary::

   aerosandbox.tools.pretty_plots.plots.contour.x


Functions
---------

.. autoapisummary::

   aerosandbox.tools.pretty_plots.plots.contour.contour


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

.. py:function:: contour(*args, levels = 31, colorbar = True, linelabels = True, cmap=None, alpha = 0.7, extend = 'neither', linecolor='k', linewidths = 0.5, extendrect = True, linelabels_format = eng_string, linelabels_fontsize = 8, max_side_length_nondim = np.inf, colorbar_label = None, x_log_scale = False, y_log_scale = False, z_log_scale = False, mask = None, drop_nans = None, contour_kwargs = None, contourf_kwargs = None, colorbar_kwargs = None, linelabels_kwargs = None, **kwargs)

   An analogue for plt.contour and plt.tricontour and friends that produces a much prettier default graph.

   Can take inputs with either contour or tricontour syntax.

   See syntax here:
       https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.contour.html
       https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.contourf.html
       https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.tricontour.html
       https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.tricontourf.html

   :param X: If dataset is gridded, follow `contour` syntax. Otherwise, follow `tricontour` syntax.
   :param Y: If dataset is gridded, follow `contour` syntax. Otherwise, follow `tricontour` syntax.
   :param Z: If dataset is gridded, follow `contour` syntax. Otherwise, follow `tricontour` syntax.
   :param levels: See contour docs.
   :param colorbar: Should we draw a colorbar?
   :param linelabels: Should we add line labels?
   :param cmap: What colormap should we use?
   :param alpha: What transparency should all plot elements be?
   :param extend: See contour docs.
   :param linecolor: What color should the line labels be?
   :param linewidths: See contour docs.
   :param extendrect: See colorbar docs.
   :param linelabels_format: See ax.clabel docs.
   :param linelabels_fontsize: See ax.clabel docs.
   :param contour_kwargs: Additional keyword arguments for contour.
   :param contourf_kwargs: Additional keyword arguments for contourf.
   :param colorbar_kwargs: Additional keyword arguments for colorbar.
   :param linelabels_kwargs: Additional keyword arguments for the line labels (ax.clabel).
   :param \*\*kwargs: Additional keywords, which are passed to both contour and contourf.

   Returns: A tuple of (contour, contourf, colorbar) objects.



.. py:data:: x