bucky.viz.plot
#
Creates plots for Bucky data.
Module Contents#
Functions#
|
Function to create plots given a tuple of input data. |
|
Adds simulation data for requested column to initialized matplotlib axis object. |
|
Creates default Bucky plot, one plot per unique ADM region containing as many subplots as columns requested. |
|
Main entrypoint. |
|
Adds simulation data for requested column to initialized matplotlib axis object. |
- bucky.viz.plot._pool_plot(args)[source]#
Function to create plots given a tuple of input data.
This input data should include a pandas DataFrameGroupBy object, the plot name, historical data in the same order as the keys in the GroupBy object, the columns and quantiles to plot, the admin key, and the directory to save plots and CSVs.
- Parameters:
args (
tuple
) – Zipped input data
- bucky.viz.plot.add_simulation_data_to_axis(axis, col, sim_data, quantiles)[source]#
Adds simulation data for requested column to initialized matplotlib axis object.
- Parameters:
axis (
matplotlib.axes.Axes
) – Previously initialized axis objectcol (
str
) – Column to add to plotsim_data (
pandas.DataFrame
) – Area simulation dataquantiles (
list
offloat
, orNone
) – List of quantiles to plot. If None, will plot all available quantiles in data.
- Returns:
axis – Modified axis object with added data
- Return type:
- bucky.viz.plot.default_plot(cfg)[source]#
Creates default Bucky plot, one plot per unique ADM region containing as many subplots as columns requested.
- Parameters:
cfg (
BuckyConfig
) – BuckyConfig object with various plot-related parameters
- bucky.viz.plot.scale_y_axis(axis, col, sim_data, quantiles, hist_data, fit_data, zero_as_ymin=True)[source]#
Adds simulation data for requested column to initialized matplotlib axis object.
- Parameters:
axis (
matplotlib.axes.Axes
) – Previously initialized axis objectcol (
str
) – Column to add to plotsim_data (
pandas.DataFrame
) – Area simulation dataquantiles (
list
offloat
, orNone
) – List of quantiles in datahist_data (
pandas.DataFrame
) – Historical datafit_data (
pandas.DataFrame
) – Fitted historical datazero_as_ymin (
bool
) – If true, uses zero as y-axis minimum
- Returns:
axis – Modified axis object with modified y-axis limits
- Return type: