spacepy.pybats.add_planet

spacepy.pybats.add_planet(ax, rad=1.0, ang=0.0, add_night=True, zorder=1000, **extra_kwargs)[source]

Creates a circle of radius=self.para['rbody'] and returns the MatPlotLib Ellipse patch object for plotting. If an axis is specified using the ax keyword, the patch is added to the plot.

Unlike the add_body method, the circle is colored half white (dayside) and half black (nightside) to coincide with the direction of the sun. Additionally, because the size of the planet is not intrinsically known to the MHD file, the kwarg “rad”, defaulting to 1.0, sets the size of the planet. add_night can turn off this behavior.

Extra keywords are handed to the Ellipse generator function.

Parameters
axMatplotlib Axes object

Set the axes on which to place planet.

Other Parameters
radfloat

Set radius of planet. Defaults to 1.

angfloat

Set the rotation of the day-night terminator from the y-axis, in degrees. Defaults to zero (terminator is aligned with Y-axis.)

add_nightboolean

Add night hemisphere. Defaults to True

zorderint

Set the matplotlib zorder of the patch to set how other plot elements order with the inner boundary patch. Defaults to 1000, nightside patch is given zorder of zorder+5.