Spp
========================

.. py:module:: gridstatus.spp


Module Contents
---------------

Classes Summary
~~~~~~~~~~~~~~~

.. autoapisummary::

   gridstatus.spp.SPP





Attributes Summary
~~~~~~~~~~~~~~~~~~~

.. autoapisummary::

   gridstatus.spp.FILE_BROWSER_API_URL
   gridstatus.spp.FS_DAM_LMP_BY_LOCATION
   gridstatus.spp.FS_RTBM_LMP_BY_LOCATION
   gridstatus.spp.LAST_UPDATED_KEYWORDS
   gridstatus.spp.LOCATION_TYPE_HUB
   gridstatus.spp.LOCATION_TYPE_INTERFACE
   gridstatus.spp.LOCATION_TYPE_SETTLEMENT_LOCATION
   gridstatus.spp.MARKETPLACE_BASE_URL
   gridstatus.spp.QUERY_RTM5_HUBS_URL
   gridstatus.spp.QUERY_RTM5_INTERFACES_URL
   gridstatus.spp.RELIABILITY_LEVELS
   gridstatus.spp.RELIABILITY_LEVELS_ALIASES
   gridstatus.spp.STATUS_STOP_WORDS


Contents
~~~~~~~~~~~~~~~~~~~
.. py:data:: FILE_BROWSER_API_URL
   :value: 'https://marketplace.spp.org/file-browser-api/'

   

.. py:data:: FS_DAM_LMP_BY_LOCATION
   :value: 'da-lmp-by-location'

   

.. py:data:: FS_RTBM_LMP_BY_LOCATION
   :value: 'rtbm-lmp-by-location'

   

.. py:data:: LAST_UPDATED_KEYWORDS
   :value: ['last updated', 'as of']

   

.. py:data:: LOCATION_TYPE_HUB
   :value: 'HUB'

   

.. py:data:: LOCATION_TYPE_INTERFACE
   :value: 'INTERFACE'

   

.. py:data:: LOCATION_TYPE_SETTLEMENT_LOCATION
   :value: 'SETTLEMENT_LOCATION'

   

.. py:data:: MARKETPLACE_BASE_URL
   :value: 'https://marketplace.spp.org'

   

.. py:data:: QUERY_RTM5_HUBS_URL
   :value: 'https://pricecontourmap.spp.org/arcgis/rest/services/MarketMaps/RTBM_FeatureData/MapServer/1/query'

   

.. py:data:: QUERY_RTM5_INTERFACES_URL
   :value: 'https://pricecontourmap.spp.org/arcgis/rest/services/MarketMaps/RTBM_FeatureData/MapServer/2/query'

   

.. py:data:: RELIABILITY_LEVELS
   :value: ['Normal Operations', 'Weather Advisory', 'Resource Advisory', 'Conservative Operations...

   

.. py:data:: RELIABILITY_LEVELS_ALIASES

   

.. py:class:: SPP

   Bases: :py:obj:`gridstatus.base.ISOBase`

   Southwest Power Pool (SPP)


   **Attributes**

   .. list-table::
      :widths: 15 85
      :header-rows: 0

      * - **default_timezone**
        - US/Central
      * - **interconnection_homepage**
        - https://www.spp.org/engineering/generator-interconnection/
      * - **iso_id**
        - spp
      * - **location_types**
        - None
      * - **markets**
        - None
      * - **name**
        - Southwest Power Pool
      * - **status_homepage**
        - https://www.spp.org/markets-operations/current-grid-conditions/


   **Methods**

   .. autoapisummary::
      :nosignatures:

      gridstatus.spp.SPP.get_fuel_mix
      gridstatus.spp.SPP.get_interconnection_queue
      gridstatus.spp.SPP.get_lmp
      gridstatus.spp.SPP.get_load
      gridstatus.spp.SPP.get_load_forecast
      gridstatus.spp.SPP.get_status

   .. py:method:: get_fuel_mix(date, verbose=False)


   .. py:method:: get_interconnection_queue(verbose=False)

      Get interconnection queue

      :returns: Interconnection queue
      :rtype: pandas.DataFrame


   .. py:method:: get_lmp(date, end=None, market: str = None, locations: list = 'ALL', location_type: str = LOCATION_TYPE_HUB, verbose=False)

      Get LMP data

      Supported Markets:
          - ``REAL_TIME_5_MIN``
          - ``DAY_AHEAD_HOURLY``

      Supported Location Types:
          - ``hub``
          - ``interface``
          - ``settlement_location``


   .. py:method:: get_load(date, verbose=False)

      Returns load for last 24hrs in 5 minute intervals


   .. py:method:: get_load_forecast(date, forecast_type='MID_TERM', verbose=False)

      Returns load forecast for next 7 days in hourly intervals

      :param forecast_type: MID_TERM is hourly for next 7 days or SHORT_TERM is
                            every five minutes for a few hours
      :type forecast_type: str

      :returns: forecast for current day
      :rtype: pd.DataFrame


   .. py:method:: get_status(date=None, verbose=False)



.. py:data:: STATUS_STOP_WORDS
   :value: ['as', 'at', 'ct', 'eea', 'of', 'on']