hermpy.plotting.boundary_models
===============================

.. py:module:: hermpy.plotting.boundary_models


Functions
---------

.. autoapisummary::

   hermpy.plotting.boundary_models.plot_magnetospheric_boundaries


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

.. py:function:: plot_magnetospheric_boundaries(ax: matplotlib.pyplot.Axes, plane: str = 'xy', sub_solar_magnetopause: float = 1.45, alpha: float = 0.5, psi: float = 1.04, p: float = 2.75, initial_x: float = 0.5, add_legend: bool = False, zorder: int = 0, color='black', lw=1) -> None

   Add average magnetopause and bow shock locations based on
   Winslow et al. (2013).

   Add the plane projection of the average magnetopause and
   bow shock locations based on Winslow et al. (2013).
   These are plotted in units of Mercury radii.


   Parameters
   ----------
   ax : pyplot.Axes
       The pyplot axis to add the boundaries to.

   plane : str {`"xy"`, `"xz"`, `"yz"`}, optional
       What plane to project the boundaries to. yz is not yet
       implimented.

   add_legend : bool {`True`, `False`}, optional
       Should pyplot legend labels be added.


   Returns
   -------
   None