Base

Base#

Module Contents#

Classes Summary#

`GridStatus`
`InterconnectionQueueStatus`	Interconnection queue types
`ISOBase`
`Markets`	Names of LMP Markets

Exceptions Summary#

Contents#

class gridstatus.base.GridStatus(time, status, reserves, iso, notes=None, unit='MW')[source]#

Attributes

iso	None
notes	None
reserves	None
status	None
time	None
unit	‘MW’

Methods

`__repr__`(→ str)
`to_dict`()

__repr__() → str[source]#

to_dict()[source]#

class gridstatus.base.InterconnectionQueueStatus(*args, **kwds)[source]#

Bases: enum.Enum

Interconnection queue types

Attributes

ACTIVE	‘Active’
COMPLETED	‘Completed’
WITHDRAWN	‘Withdrawn’

class gridstatus.base.ISOBase[source]#

Attributes

default_timezone	None
interconnection_homepage	None
markets	[]
status_homepage	None

Methods

`get_fuel_mix`(date[, end, verbose])
`get_interconnection_queue`([verbose])
`get_load`(date[, end, verbose])
`get_load_forecast`(date[, end, verbose])
`get_raw_interconnection_queue`(→ BinaryIO)
`get_status`(date[, end, verbose])
`get_storage`(date[, end, verbose])
`local_now`()
`safe_for_dst_transition_floor`(→ pandas.Timestamp)

abstractmethod get_fuel_mix(date, end=None, verbose=False)[source]#

abstractmethod get_interconnection_queue(verbose: bool = False)[source]#

abstractmethod get_load(date, end=None, verbose=False)[source]#

abstractmethod get_load_forecast(date, end=None, verbose=False)[source]#

abstractmethod get_raw_interconnection_queue(verbose: bool = False) → BinaryIO[source]#

abstractmethod get_status(date, end=None, verbose=False)[source]#

abstractmethod get_storage(date, end=None, verbose=False)[source]#

local_now()[source]#

safe_for_dst_transition_floor(date: pandas.Timestamp, freq: str) → pandas.Timestamp[source]#

class gridstatus.base.Markets[source]#

Bases: enum.StrEnum

Names of LMP Markets

Initialize self. See help(type(self)) for accurate signature.

Attributes

DAY_AHEAD_HOURLY	‘DAY_AHEAD_HOURLY’
DAY_AHEAD_HOURLY_EX_ANTE	‘DAY_AHEAD_HOURLY_EX_ANTE’
DAY_AHEAD_HOURLY_EX_POST	‘DAY_AHEAD_HOURLY_EX_POST’
REAL_TIME_15_MIN	‘REAL_TIME_15_MIN’
REAL_TIME_5_MIN	‘REAL_TIME_5_MIN’
REAL_TIME_5_MIN_EX_ANTE	‘REAL_TIME_5_MIN_EX_ANTE’
REAL_TIME_5_MIN_EX_POST_FINAL	‘REAL_TIME_5_MIN_EX_POST_FINAL’
REAL_TIME_5_MIN_EX_POST_PRELIM	‘REAL_TIME_5_MIN_EX_POST_PRELIM’
REAL_TIME_5_MIN_FINAL	‘REAL_TIME_5_MIN_FINAL’
REAL_TIME_HOURLY	‘REAL_TIME_HOURLY’
REAL_TIME_HOURLY_EX_POST_FINAL	‘REAL_TIME_HOURLY_EX_POST_FINAL’
REAL_TIME_HOURLY_EX_POST_PRELIM	‘REAL_TIME_HOURLY_EX_POST_PRELIM’
REAL_TIME_HOURLY_FINAL	‘REAL_TIME_HOURLY_FINAL’
REAL_TIME_HOURLY_PRELIM	‘REAL_TIME_HOURLY_PRELIM’
REAL_TIME_SCED	‘REAL_TIME_SCED’

Methods

__contains__(item)

Return bool(key in self).

__contains__(item)[source]#: Return bool(key in self).

exception gridstatus.base.NoDataFoundException[source]#

Bases: Exception

Common base class for all non-exit exceptions.

Initialize self. See help(type(self)) for accurate signature.

exception gridstatus.base.NotSupported[source]#

Bases: Exception

Common base class for all non-exit exceptions.

Initialize self. See help(type(self)) for accurate signature.

exception gridstatus.base.RetiredDataException[source]#

Bases: Exception

Common base class for all non-exit exceptions.

Initialize self. See help(type(self)) for accurate signature.