Pjm
========================

.. py:module:: gridstatus.pjm


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

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

.. autoapisummary::

   gridstatus.pjm.PJM





Contents
~~~~~~~~~~~~~~~~~~~
.. py:class:: PJM

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

   PJM


   **Attributes**

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

      * - **default_timezone**
        - US/Eastern
      * - **hub_node_ids**
        - ['51217', '116013751', '35010337', '34497151', '34497127', '34497125', '33092315', '33092313', '33092311', '4669664', '51288', '51287']
      * - **interconnection_homepage**
        - https://www.pjm.com/planning/services-requests/interconnection-queues.aspx
      * - **iso_id**
        - pjm
      * - **location_types**
        - ['ZONE', 'LOAD', 'GEN', 'AGGREGATE', 'INTERFACE', 'EXT', 'HUB', 'EHV', 'TIE', 'RESIDUAL_METERED_EDC']
      * - **markets**
        - None
      * - **name**
        - PJM
      * - **zone_node_ids**
        - ['1', '3', '51291', '51292', '51293', '51295', '51296', '51297', '51298', '51299', '51300', '51301', '7633629', '8394954', '8445784', '33092371', '34508503', '34964545', '37737283', '116013753', '124076095', '970242670', '1709725933']


   **Methods**

   .. autoapisummary::
      :nosignatures:

      gridstatus.pjm.PJM.get_fuel_mix
      gridstatus.pjm.PJM.get_interconnection_queue
      gridstatus.pjm.PJM.get_lmp
      gridstatus.pjm.PJM.get_load
      gridstatus.pjm.PJM.get_load_forecast
      gridstatus.pjm.PJM.get_pnode_ids

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

      Get fuel mix for a date or date range  in hourly intervals


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


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

      Returns LMP at a previous date

      .. rubric:: Notes

      * If start date is prior to the PJM archive date, all data
      must be downloaded before location filtering can be performed
      due to limitations of PJM API. The archive date is
      186 days (~6 months) before today for the 5 minute real time
      market and 731 days (~2 years) before today for the Hourly
      Real Time and Day Ahead Hourly markets. Node type filter can be
      performed for Real Time Hourly and Day Ahead Hourly markets.

      * If location_type is provided, it is filtered after data
      is retrieved for Real Time 5 Minute market regardless of the
      date. This is due to PJM api limitations

      :param date: date to get LMPs for
      :type date: datetime.date, str
      :param end: end date to get LMPs for
      :type end: datetime.date, str
      :param market: Supported Markets:
                     REAL_TIME_5_MIN, REAL_TIME_HOURLY, DAY_AHEAD_HOURLY
      :type market: str
      :param locations: list of pnodeid to get LMPs for.
                        Defaults to "hubs". Use get_pnode_ids() to get
                        a list of possible pnode ids. If "all", will
                        return data from all p nodes (warning there are
                        over 10,000 unique pnodes, so expect millions or billions of rows!)
      :type locations: list, optional
      :param location_type: If specified,
                            will only return data for nodes of this type.
                            Defaults to None. Possible location types are: 'ZONE',
                            'LOAD', 'GEN', 'AGGREGATE', 'INTERFACE', 'EXT',
                            'HUB', 'EHV', 'TIE', 'RESIDUAL_METERED_EDC'.
      :type location_type: str, optional


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

      Returns load at a previous date at 5 minute intervals

      :param date: date to get load for. must be in last 30 days
      :type date: datetime.date, str

      :returns: Load data time series. Columns: Time, Load, and all areas

                * Load columns represent PJM-wide load
                * Returns data for the following areas: AE, AEP, APS, ATSI,
                BC, COMED, DAYTON, DEOK, DOM, DPL, DUQ, EKPC, JC,
                ME, PE, PEP, PJM MID ATLANTIC REGION, PJM RTO,
                PJM SOUTHERN REGION, PJM WESTERN REGION, PL, PN, PS, RECO
      :rtype: pd.DataFrame


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

      Get forecast for today in hourly intervals.

      Updates every Every half hour on the quarter E.g. 1:15 and 1:45



   .. py:method:: get_pnode_ids()