powersimdata.network.constants.region package

Subpackages

• powersimdata.network.constants.region.tests package
  • Submodules
  • powersimdata.network.constants.region.tests.test_zones module
    • test_check_zone_argument_type()
    • test_check_zone_column()
    • test_check_zone_index()
  • Module contents

Submodules

powersimdata.network.constants.region.division module

class powersimdata.network.constants.region.division.DivisionMapping(zone)

Bases: object

State/Country mapping for grid models.

Parameters:

zone (pandas.DataFrame) – information on zones of a grid model.

class powersimdata.network.constants.region.division.EUDivisionMapping(zone)

Bases: DivisionMapping

Country mapping for EU grid models

Parameters:

zone (pandas.DataFrame) – information on zones of a grid model.

class powersimdata.network.constants.region.division.USADivisionMapping(zone)

Bases: DivisionMapping

State mapping for USA grid models

Parameters:

zone (pandas.DataFrame) – information on zones of a grid model.

powersimdata.network.constants.region.division.get_division_mapping(model, zone)

Return division mappings for a grid model.

Parameters:

• model (str) – grid model.

• zone (pandas.DataFrame) – information on zones of a grid model.

powersimdata.network.constants.region.geography module

class powersimdata.network.constants.region.geography.EU

Bases: object

Geographical and timezone information for USA grid models

class powersimdata.network.constants.region.geography.USA

Bases: object

Geographical and timezone information for USA grid models

substitute()

Replace ERCOT with Texas in all attributes.

Returns:

(dict) – updated attributes.

powersimdata.network.constants.region.geography.format(name)

Format a list of words.

Parameters:

name (list) – list of words

powersimdata.network.constants.region.geography.get_geography(model)

Return geographical and time zone information for a grid model.

Parameters:

model (str) – grid model

powersimdata.network.constants.region.interconnect module

class powersimdata.network.constants.region.interconnect.InterconnectMapping(model, zone)

Bases: object

Interconnect mapping for grid models

Parameters:

• model (str) – grid model.

• zone (pandas.DataFrame) – information on zones of a grid model.

powersimdata.network.constants.region.interconnect.get_interconnect_mapping(model, zone)

Return interconnect mappings for a grid model.

Parameters:

• model (str) – grid model

• zone (pandas.DataFrame) – information on zones of a grid model.

powersimdata.network.constants.region.loadzone module

class powersimdata.network.constants.region.loadzone.EULoadzoneMapping(zone)

Bases: LoadzoneMapping

Loadzone mapping for EU grid models

Parameters:

zone (pandas.DataFrame) – information on zones of a grid model.

class powersimdata.network.constants.region.loadzone.LoadzoneMapping(zone)

Bases: object

Loadzone mapping for grid models

Parameters:

zone (pandas.DataFrame) – information on zones of a grid model.

class powersimdata.network.constants.region.loadzone.USALoadzoneMapping(zone)

Bases: LoadzoneMapping

Loadzone mapping for USA grid models

Parameters:

zone (pandas.DataFrame) – information on zones of a grid model.

powersimdata.network.constants.region.loadzone.get_loadzone_mapping(model, zone)

Return loadzone mappings for a grid model.

Parameters:

• model (str) – grid model

• zone (pandas.DataFrame) – information on zones of a grid model.

powersimdata.network.constants.region.mapping module

class powersimdata.network.constants.region.mapping.EUMapping(model, interconnect, info)

Bases: Mapping

Geographical/time mapping for EU grid models

Parameters:

• model (str) – grid model.

• interconnect (list) – interconnect(s)

• info (pandas.DataFrame) – information on zones of a grid model.

class powersimdata.network.constants.region.mapping.Mapping(model, interconnect, info)

Bases: object

Geographical/time mapping for USA grid models

Parameters:

• model (str) – grid model.

• interconnect (list) – interconnect(s)

• info (pandas.DataFrame) – information on zones of a grid model.

class powersimdata.network.constants.region.mapping.USAMapping(model, interconnect, info)

Bases: Mapping

Geographical/time mapping for USA grid models

Parameters:

• model (str) – grid model.

• interconnect (list) – interconnect(s)

• info (pandas.DataFrame) – information on zones of a grid model.

powersimdata.network.constants.region.mapping.get_mapping(model, interconnect, info)

Return interconnect mappings for a grid model.

Parameters:

• model (str) – grid model.

• interconnect (list) – interconnect(s)

• info (pandas.DataFrame) – information on zones of a grid model.

powersimdata.network.constants.region.zones module

powersimdata.network.constants.region.zones.check_zone(model, zone)

Validate data frame used in powersimdata.network.model.ModelImmutables class.

Parameters:

• model (str) – grid model.

• zone (pandas.DataFrame) – data frame to be tested.

Raises:

• TypeError – if zone is not a pandas.DataFrame

• ValueError – if index name is not ‘zone_id’ if ‘zone_name’, ‘state’/’country’ (model dependent), ‘interconnect’, ‘time_zone’ and ‘abv’ are not in columns.

powersimdata.network.constants.region.zones.from_csv(model)

Returns geographical and timezone information of a grid model from a CSV file.

Parameters:

model (str) – grid model.

Returns:

(pandas.DataFrame) – a data frame with loadzone name (‘zone_name’), division name (e.g. ‘state’ name for USA grid models), interconnect name (‘interconnect’), time zone of loadzone (‘time_zone’), division abbreviation (‘abv’) as columns and loadzone id (‘zone_id’) as indices.

powersimdata.network.constants.region.zones.from_pypsa(model, info)

Returns geographical and timezone information of a grid model from a PyPSA Network object.

Parameters:

• model (str) – grid model.

• info (pd.DataFrame) – a data frame with loadzone id as index and loadzone name (‘zone_name’) and division abbreviation (‘abv’) as columns.

Returns:

(pandas.DataFrame) – a data frame with loadzone name (‘zone_name’), division name (e.g. ‘country’ name for EU grid models), interconnect name (‘interconnect’), time zone of loadzone (‘time_zone’), division abbreviation (‘abv’) as columns and loadzone id (‘zone_id’) as indices.

Module contents