Skip to content
R2X framework logoR2X framework logor2x-reeds

ReEDSRegion

Source

ReEDS regional component.

Import

Section titled “Import”
>>> from r2x_reeds import ReEDSRegion
>>> assert ReEDSRegion is not None

Bases: ReEDSComponent. Inherited contracts remain defined by the base classes.

Declared fields

Section titled “Declared fields”

These fields are declared on this class. Required/default behavior is shown directly from source. Base-class fields also apply.

state

Section titled “state”
state: Annotated[str | None, Field(description='State abbreviation')] = None

nerc_region

Section titled “nerc_region”
nerc_region: Annotated[str | None, Field(description='NERC region')] = None

transmission_region

Section titled “transmission_region”
transmission_region: Annotated[str | None, Field(description='Transmission planning region')] = None

transmission_group

Section titled “transmission_group”
transmission_group: Annotated[str | None, Field(description='Transmission group')] = None

interconnect

Section titled “interconnect”
interconnect: Annotated[str | None, Field(description='Interconnection (eastern, western, texas)')] = None

country

Section titled “country”
country: Annotated[str | None, Field(description='Country code')] = None

max_active_power

Section titled “max_active_power”
max_active_power: Annotated[float | None, Field(description='Peak demand in MW')] = None

timezone

Section titled “timezone”
timezone: Annotated[str | None, Field(description='Time zone identifier')] = None

cendiv

Section titled “cendiv”
cendiv: Annotated[str | None, Field(description='Census division')] = None

usda_region

Section titled “usda_region”
usda_region: Annotated[str | None, Field(description='USDA region')] = None

h2ptc_region

Section titled “h2ptc_region”
h2ptc_region: Annotated[str | None, Field(description='H2 PTC region')] = None

hurdle_region

Section titled “hurdle_region”
hurdle_region: Annotated[str | None, Field(description='Hurdle rate region')] = None

cc_region

Section titled “cc_region”
cc_region: Annotated[str | None, Field(description='Climate change region')] = None

Declared methods and properties

Section titled “Declared methods and properties”

example

Section titled “example”

Source

@classmethod
example(cls) -> ReEDSRegion

Example region.

Continue with the Python API overview and transform contracts.