rdtools.plotting.availability_summary_plots

rdtools.plotting.availability_summary_plots(power_system, power_subsystem, loss_total, energy_cumulative, energy_expected_rescaled, outage_info)

Create a figure summarizing the availability analysis results.

Because all of the parameters to this function are products of an AvailabilityAnalysis object, it is usually easier to use availability.AvailabilityAnalysis.plot() instead of running this function manually.

Warning

The availability module is currently experimental. The API, results, and default behaviors may change in future releases (including MINOR and PATCH releases) as the code matures.

Parameters

  • power_system (pandas.Series) -- Timeseries total system power.

  • power_subsystem (pandas.DataFrame) -- Timeseries power data, one column per subsystem.

  • loss_total (pandas.Series) -- Timeseries system lost power.

  • energy_cumulative (pandas.Series) -- Timeseries system cumulative energy.

  • energy_expected_rescaled (pandas.Series) -- Timeseries expected energy, rescaled to match actual energy. This reflects interval energy, not cumulative.

  • outage_info (pandas.DataFrame) -- A dataframe with information about system outages.

Returns

fig

Return type

matplotlib.figure.Figure

See also

rdtools.availability.AvailabilityAnalysis.plot

Examples

>>> aa = AvailabilityAnalysis(...)
>>> aa.run()
>>> fig = rdtools.plotting.availability_summary_plots(aa.power_system,
...     aa.power_subsystem, aa.loss_total, aa.energy_cumulative,
...     aa.energy_expected_rescaled, aa.outage_info)