enlilviz.plotting package¶
Submodules¶
enlilviz.plotting.forecaster module¶
Default forecast center figure.
-
class
enlilviz.plotting.forecaster.
ForecasterPlot
(enlil_run, watermark=None)¶ Bases:
object
Figure class for the main Forecaster plot.
Parameters: - enlil_run (enlilviz.enlil.Enlil) – An Enlil model run.
- watermark (str, optional) – An optional watermark to add to the plots.
-
save
(filename=None)¶ Saves the current figure with the given filename. If filename is None, the filename will be made from the current time: ‘enlil_{curr_time}.png’.
-
time
¶ Current time of the plot.
-
update
()¶ Updates the plot with all of the proper data.
enlilviz.plotting.plots module¶
Generic plot wrappers for Enlil objects.
-
class
enlilviz.plotting.plots.
Colorbar
(var, ax=None)¶ Bases:
object
Colorbar axis.
-
class
enlilviz.plotting.plots.
LatitudeSlice
(enlil_run, var, ax=None)¶ Bases:
enlilviz.plotting.plots._BasePlot
A latitude polar slice plot, which is in longitude-radial coordinates.
Parameters: var (str) – Variable to plot (den, vel) -
update
()¶ Update all variable quantities within the plot.
-
-
class
enlilviz.plotting.plots.
LongitudeSlice
(enlil_run, var, ax=None)¶ Bases:
enlilviz.plotting.plots._BasePlot
A longitude polar slice plot, which is in latitude-radial coordinates.
Parameters: var (str) – Variable to plot (den, vel) -
update
()¶ Update all variable quantities within the plot.
-
-
class
enlilviz.plotting.plots.
RadialSlice
(enlil_run, var, ax=None)¶ Bases:
enlilviz.plotting.plots._BasePlot
A radial slice plot, which is in longitude-latitude coordinates.
Parameters: var (str) – Variable to plot (den, vel) -
update
()¶ Update all variable quantities within the plot.
-
-
class
enlilviz.plotting.plots.
TimeSeries
(enlil_run, sat, var, coord=None, ax=None)¶ Bases:
enlilviz.plotting.plots._BasePlot
A time series plot of satellite data.
Parameters: - sat (str) – Satellite of interest (Earth, STEREO_A, STEREO_B)
- var (str) – Variable to plot (den, vel)
-
update
()¶ Update all variable quantities within the plot.
Module contents¶
Plotting extras for Enlil.
-
class
enlilviz.plotting.
ForecasterPlot
(enlil_run, watermark=None)¶ Bases:
object
Figure class for the main Forecaster plot.
Parameters: - enlil_run (enlilviz.enlil.Enlil) – An Enlil model run.
- watermark (str, optional) – An optional watermark to add to the plots.
-
save
(filename=None)¶ Saves the current figure with the given filename. If filename is None, the filename will be made from the current time: ‘enlil_{curr_time}.png’.
-
time
¶ Current time of the plot.
-
update
()¶ Updates the plot with all of the proper data.
-
class
enlilviz.plotting.
LatitudeSlice
(enlil_run, var, ax=None)¶ Bases:
enlilviz.plotting.plots._BasePlot
A latitude polar slice plot, which is in longitude-radial coordinates.
Parameters: var (str) – Variable to plot (den, vel) -
update
()¶ Update all variable quantities within the plot.
-
-
class
enlilviz.plotting.
LongitudeSlice
(enlil_run, var, ax=None)¶ Bases:
enlilviz.plotting.plots._BasePlot
A longitude polar slice plot, which is in latitude-radial coordinates.
Parameters: var (str) – Variable to plot (den, vel) -
update
()¶ Update all variable quantities within the plot.
-
-
class
enlilviz.plotting.
RadialSlice
(enlil_run, var, ax=None)¶ Bases:
enlilviz.plotting.plots._BasePlot
A radial slice plot, which is in longitude-latitude coordinates.
Parameters: var (str) – Variable to plot (den, vel) -
update
()¶ Update all variable quantities within the plot.
-
-
class
enlilviz.plotting.
TimeSeries
(enlil_run, sat, var, coord=None, ax=None)¶ Bases:
enlilviz.plotting.plots._BasePlot
A time series plot of satellite data.
Parameters: - sat (str) – Satellite of interest (Earth, STEREO_A, STEREO_B)
- var (str) – Variable to plot (den, vel)
-
update
()¶ Update all variable quantities within the plot.
-
class
enlilviz.plotting.
Title
(enlil_run, ax=None)¶ Bases:
enlilviz.plotting.plots._BasePlot
A title axis with the current time.
-
update
()¶ Update all variable quantities within the plot.
-
-
class
enlilviz.plotting.
Colorbar
(var, ax=None)¶ Bases:
object
Colorbar axis.