powersimdata.design package

Subpackages

Submodules

powersimdata.design.mimic_grid module

powersimdata.design.mimic_grid.mimic_generation_capacity(base_grid, ref_grid)[source]

Given a base grid and a reference grid, determine zone and plant scaling factors such that the combination, when applied to the base grid, produces the reference grid.

Parameters:
Returns:

(dict) – dictionary of plant/zone scaling factors in a format matching ct in powersimdata.input.change_table.ChangeTable.

powersimdata.design.scenario_info module

class powersimdata.design.scenario_info.ScenarioInfo(scenario)[source]

Bases: object

Gather information from previous scenarios for capacity scaling.

Parameters:

scenario (powersimdata.scenario.scenario.Scenario) – scenario instance

Raises:

TypeError – if the scenario is not in ‘analyze’ state.

area_to_loadzone(area, area_type=None)[source]
Map the query area to a list of loadzones. For more info, see

powersimdata.network.model.area_to_loadzone().

Parameters:
  • area (str) – one of: loadzone, state, state abbreviation, interconnect, ‘all’

  • area_type (str) – one of: ‘loadzone’, ‘state’, ‘state_abbr’, ‘interconnect’

Returns:

(set) – set of loadzones associated to the query area

get_available_resource(area, area_type=None)[source]
Find the available resources of a specific area in the grid of the

given scenario

Parameters:
  • area (str) – one of: loadzone, state, state abbreviation, interconnect, ‘all’

  • area_type (str) – one of: ‘loadzone’, ‘state’, ‘state_abbr’, ‘interconnect’

Returns:

(list) – a list of available resources in the query area

get_capacity(gentype, area, area_type=None)[source]
Calculate the total capacity of the query gentype in the query area

of the given scenario

Parameters:
  • gentype (str) – type of generator

  • area (str) – one of: loadzone, state, state abbreviation, interconnect, ‘all’

  • area_type (str) – one of: ‘loadzone’, ‘state’, ‘state_abbr’, ‘interconnect’

Returns:

(float) – total capacity (in MW) based on the specified parameters

get_capacity_factor(gentype, area, start_time, end_time, area_type=None)[source]
Calculate the capacity factor of the query gentype in the

query area during the query time range of the given scenario

Parameters:
  • gentype (str) – type of generator

  • area (str) – one of: loadzone, state, state abbreviation, interconnect, ‘all’

  • start_time (str) – start timestamp in the format ‘YYYY-MM-DD HH:MM:SS’

  • end_time (str) – end timestamp in the format ‘YYYY-MM-DD HH:MM:SS’

  • area_type (str) – one of: ‘loadzone’, ‘state’, ‘state_abbr’, ‘interconnect’

Returns:

(float) – capacity factor based on the specified parameters

Raises:

ZeroDivisionError – if no generator of gentype is found in the area

get_curtailment(gentype, area, start_time, end_time, area_type=None)[source]
Calculate the curtailment of the query gentype in the query

area during the query time range of the given scenario

Parameters:
  • gentype (str) – type of generator

  • area (str) – one of: loadzone, state, state abbreviation, interconnect, ‘all’

  • start_time (str) – start timestamp in the format ‘YYYY-MM-DD HH:MM:SS’

  • end_time (str) – end timestamp in the format ‘YYYY-MM-DD HH:MM:SS’

  • area_type (str) – one of: ‘loadzone’, ‘state’, ‘state_abbr’, ‘interconnect’

Returns:

(float) – curtailment percentage (rounded up to two decimals) based on the specified parameters

get_demand(area, start_time, end_time, area_type=None)[source]
Calculate the total demand of the query area during the query time

range of the given scenario

Parameters:
  • area (str) – one of: loadzone, state, state abbreviation, interconnect, ‘all’

  • start_time (str) – start timestamp in the format ‘YYYY-MM-DD HH:MM:SS’

  • end_time (str) – end timestamp in the format ‘YYYY-MM-DD HH:MM:SS’

  • area_type (str) – one of: ‘loadzone’, ‘state’, ‘state_abbr’, ‘interconnect’

Returns:

(float) – total demand (in MWh) based on the specified parameters

get_generation(gentype, area, start_time, end_time, area_type=None)[source]
Calculate the total generation of the query gentype in the query

area during the query time range of the given scenario

Parameters:
  • gentype (str) – type of generator

  • area (str) – one of: loadzone, state, state abbreviation, interconnect, ‘all’

  • start_time (str) – start timestamp in the format ‘YYYY-MM-DD HH:MM:SS’

  • end_time (str) – end timestamp in the format ‘YYYY-MM-DD HH:MM:SS’

  • area_type (str) – one of: ‘loadzone’, ‘state’, ‘state_abbr’, ‘interconnect’

Returns:

(float) – total generation (in MWh) based on the specified parameters

get_no_congest_capacity_factor(gentype, area, start_time, end_time, area_type=None)[source]
Calculate the no congestion capacity factor of the query gentype

in the query area during the query time range of the given scenario

Parameters:
  • gentype (str) – type of generator

  • area (str) – one of: loadzone, state, state abbreviation, interconnect, ‘all’

  • start_time (str) – start timestamp in the format ‘YYYY-MM-DD HH:MM:SS’

  • end_time (str) – end timestamp in the format ‘YYYY-MM-DD HH:MM:SS’

  • area_type (str) – one of: ‘loadzone’, ‘state’, ‘state_abbr’, ‘interconnect’

Returns:

(float) – no congestion capacity factor based on the specified parameters

get_profile_resource(gentype, area, start_time, end_time, area_type=None)[source]
Calculate the total resource from profile of the query gentype in

the query area during the query time range of the given scenario

Parameters:
  • gentype (str) – type of generator

  • area (str) – one of: loadzone, state, state abbreviation, interconnect, ‘all’

  • start_time (str) – start timestamp in the format ‘YYYY-MM-DD HH:MM:SS’

  • end_time (str) – end timestamp in the format ‘YYYY-MM-DD HH:MM:SS’

  • area_type (str) – one of: ‘loadzone’, ‘state’, ‘state_abbr’, ‘interconnect’

Returns:

(float) – total resource from profile (in MWh) based on the specified parameters

Raises:

ValueError – if the resource type is invalid

Module contents