reV.qa_qc.summary.SummarizeSupplyCurve

class SummarizeSupplyCurve(sc_table)[source]

Bases: object

Summarize Supply Curve table

Methods

run(sc_table, out_dir[, columns])

Summarize Supply Curve Table and save to disk

supply_curve_summary([columns, out_path])

Summarize Supply Curve Table

Attributes

sc_table

Supply Curve table
property sc_table

Supply Curve table

Returns:

pd.DataFrame

supply_curve_summary(columns=None, out_path=None)[source]

Summarize Supply Curve Table

Parameters:

  • sc_table (str | pandas.DataFrame) – Supply curve table or .csv containing table

  • columns (str | list, optional) – Column(s) to summarize, if None summarize all numeric columns, by default None

  • out_path (str, optional) – Path to .csv to save summary to, by default None

Returns:

sc_summary (pandas.DataFrame) – Summary statistics (mean, stdev, median, min, max, sum) for Supply Curve table columns

classmethod run(sc_table, out_dir, columns=None)[source]

Summarize Supply Curve Table and save to disk

Parameters:

  • sc_table (str | pandas.DataFrame) – Path to .csv containing Supply Curve table

  • out_dir (str) – Directory to dump summary .csv files to

  • columns (str | list, optional) – Column(s) to summarize, if None summarize all numeric columns, by default None