Base#

Module Contents#

Classes Summary#

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

Exceptions Summary#

Attributes Summary#

DEFAULT_CIPHERS

Contents#

gridstatus.base.DEFAULT_CIPHERS = ALL:@SECLEVEL=1[source]#

class gridstatus.base.FuelMix(time, mix, iso=None, unit='MW')[source]#

Methods

__repr__

Return repr(self).

__repr__() → str[source]#: Return repr(self).

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

Methods

__repr__

Return repr(self).

__repr__() → str[source]#: Return repr(self).

class gridstatus.base.InterconnectionQueueStatus[source]#

Bases: enum.Enum

Interconnection queue types

Attributes

ACTIVE	Active
COMPLETED	Completed
WITHDRAWN	Withdrawn

class gridstatus.base.ISOBase[source]#

Attributes

markets	[]
status_homepage	None

Methods

`get_forecast`
`get_fuel_mix`	Get fuel mix in 5 minute intervals for a provided day
`get_interconnection_queue`
`get_load`
`get_status`
`get_storage`
`get_supply`

abstract get_forecast(date, end=None, verbose=False)[source]#

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

Get fuel mix in 5 minute intervals for a provided day

Arguments:

date (datetime or str): “latest”, “today”, or an object that can be parsed as a datetime for the day to return data.

start (datetime or str): start of date range to return. alias for date parameter. Only specify one of date or start.

end (datetime or str): “today” or an object that can be parsed as a datetime for the day to return data. Only used if requesting a range of dates.

verbose (bool): print verbose output. Defaults to False.

Returns:

pd.Dataframe: dataframe with columns: Time and columns for each fuel type

abstract get_interconnection_queue()[source]#

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

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

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

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

class gridstatus.base.Markets[source]#

Bases: enum.Enum

Names of LMP Markets

Attributes

DAY_AHEAD_HOURLY	DAY_AHEAD_HOURLY
REAL_TIME_15_MIN	REAL_TIME_15_MIN
REAL_TIME_5_MIN	REAL_TIME_5_MIN
REAL_TIME_HOURLY	REAL_TIME_HOURLY

Methods

__contains__

__contains__(item)[source]#

exception gridstatus.base.NotSupported[source]#

Bases: Exception

Common base class for all non-exit exceptions.

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