Isone
==========================

.. py:module:: gridstatus.isone


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

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

.. autoapisummary::

   gridstatus.isone.ISONE





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

.. autoapisummary::

   gridstatus.isone.iso


Contents
~~~~~~~~~~~~~~~~~~~
.. py:data:: iso

   

.. py:class:: ISONE

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

   ISO New England (ISONE)


   **Attributes**

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

      * - **default_timezone**
        - US/Eastern
      * - **hubs**
        - None
      * - **interconnection_homepage**
        - https://irtt.iso-ne.com/reports/external
      * - **interfaces**
        - None
      * - **iso_id**
        - isone
      * - **lmp_real_time_intervals**
        - ['00-04', '04-08', '08-12', '12-16', '16-20', '20-24']
      * - **markets**
        - None
      * - **name**
        - ISO New England
      * - **status_homepage**
        - https://www.iso-ne.com/markets-operations/system-forecast-status/current-system-status
      * - **zones**
        - None


   **Methods**

   .. autoapisummary::
      :nosignatures:

      gridstatus.isone.ISONE.get_btm_solar
      gridstatus.isone.ISONE.get_fuel_mix
      gridstatus.isone.ISONE.get_interconnection_queue
      gridstatus.isone.ISONE.get_lmp
      gridstatus.isone.ISONE.get_load
      gridstatus.isone.ISONE.get_load_forecast
      gridstatus.isone.ISONE.get_raw_interconnection_queue
      gridstatus.isone.ISONE.get_solar_forecast
      gridstatus.isone.ISONE.get_status
      gridstatus.isone.ISONE.get_wind_forecast

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

      Return BTM solar at a previous date in 5 minute intervals


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

      Return fuel mix at a previous date

      Provided at frequent, but irregular intervals by ISONE


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

      Get the interconnection queue. Contains active and withdrawm applications.

      More information: https://www.iso-ne.com/system-planning/interconnection-service/interconnection-request-queue/


      :returns: interconnection queue
      :rtype: pandas.DataFrame


   .. py:method:: get_lmp(date, end=None, market: str = None, locations: list = None, include_id=False, verbose=False)

      Find Node ID mapping:
          https://www.iso-ne.com/markets-operations/settlements/pricing-node-tables/


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

      Return load at a previous date in 5 minute intervals


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

      Return forecast at a previous date


   .. py:method:: get_raw_interconnection_queue(verbose=False) -> BinaryIO

      Extract raw ISONE interconnection queue data.

      ISONE interconnection queue data is available on a webpage
      as an HTML table or you can download it as an excel file.
      Obviously an excel file would be much easier to work with however,
      the helpful generalized "Status" column (Withdrawn, Active, Commercial)
      and the "Jurisdiction" column are only available as HTML.

      Also, there is helpful detailed status information in the
      FS, SIS, OS, FAC, IA columns that are represented as <img>
      tags in the HTML.

      This function replaces the <img> tags that convey detailed
      status information as text and extracts the html as a dataframe.
      You can see the image to text mapping in the upper left hand
      corner of the ISONE Queue data page: https://irtt.iso-ne.com/reports/external.


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

      Return solar forecast published on a specific date

      Forecast is published for 7 days and generated daily by 10 am.
      https://www.iso-ne.com/isoexpress/web/reports/operations/-/tree/seven-day-solar-power-forecast


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

      Get latest status for ISO NE


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

      Return wind forecast published on a specific date

      Forecast is published for 7 days and generated daily by 10 am.
      https://www.iso-ne.com/isoexpress/web/reports/operations/-/tree/seven-day-wind-power-forecast