powersimdata.output package

Submodules

powersimdata.output.output_data module

class powersimdata.output.output_data.OutputData[source]

Bases: object

Load output data.

get_data(scenario_id, field_name)[source]

Returns data either from server or from local directory.

Parameters:

  • scenario_id (str) – scenario id.

  • field_name (str) – ‘PG’, ‘PF’, ‘PF_DCLINE’, ‘LMP’, ‘CONGU’, ‘CONGL’, ‘AVERAGED_CONG’, ‘STORAGE_PG’, ‘STORAGE_E’, ‘LOAD_SHED’, ‘LOAD_SHIFT_UP’, or ‘LOAD_SHIFT_DN’.

Returns:

(pandas.DataFrame) – specified field as a data frame.

Raises:

  • FileNotFoundError – if file not found on local machine.

  • ValueError – if second argument is not an allowable field.

powersimdata.output.output_data.construct_load_shed(scenario_info, grid, ct, infeasibilities=None)[source]

Constructs load_shed dataframe from relevant scenario/grid data.

Parameters:

  • scenario_info (dict) – info attribute of Scenario object.

  • grid (powersimdata.input.grid.Grid) – grid to construct load_shed for.

  • ct (dict) – ChangeTable dictionary.

  • infeasibilities (dict/None) – dictionary of {interval (int): load shed percentage (int)}, or None.

Returns:

(pandas.DataFrame) – data frame of load_shed.

Module contents