Base
=========================

.. py:module:: gridstatus.base


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

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

.. autoapisummary::

   gridstatus.base.FuelMix
   gridstatus.base.GridStatus
   gridstatus.base.InterconnectionQueueStatus
   gridstatus.base.ISOBase
   gridstatus.base.Markets



Exceptions Summary
~~~~~~~~~~~~~~~~~~

.. autoapisummary::

   `gridstatus.base.NotSupported`




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

.. autoapisummary::

   gridstatus.base.DEFAULT_CIPHERS


Contents
~~~~~~~~~~~~~~~~~~~
.. py:data:: DEFAULT_CIPHERS
   :annotation: = ALL:@SECLEVEL=1

   

.. py:class:: FuelMix(time, mix, iso=None, unit='MW')




   **Methods**

   .. autoapisummary::
      :nosignatures:

      gridstatus.base.FuelMix.__repr__

   .. py:method:: __repr__() -> str

      Return repr(self).



.. py:class:: GridStatus(time, status, reserves, iso, notes=None, unit='MW')




   **Methods**

   .. autoapisummary::
      :nosignatures:

      gridstatus.base.GridStatus.__repr__

   .. py:method:: __repr__() -> str

      Return repr(self).



.. py:class:: InterconnectionQueueStatus

   Bases: :py:obj:`enum.Enum`

   Interconnection queue types


   **Attributes**

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

      * - **ACTIVE**
        - Active
      * - **COMPLETED**
        - Completed
      * - **WITHDRAWN**
        - Withdrawn



.. py:class:: ISOBase


   **Attributes**

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

      * - **markets**
        - []
      * - **status_homepage**
        - None


   **Methods**

   .. autoapisummary::
      :nosignatures:

      gridstatus.base.ISOBase.get_forecast
      gridstatus.base.ISOBase.get_fuel_mix
      gridstatus.base.ISOBase.get_interconnection_queue
      gridstatus.base.ISOBase.get_load
      gridstatus.base.ISOBase.get_status
      gridstatus.base.ISOBase.get_storage
      gridstatus.base.ISOBase.get_supply

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


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

      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


   .. py:method:: get_interconnection_queue()
      :abstractmethod:


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


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


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


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



.. py:class:: Markets

   Bases: :py:obj:`enum.Enum`

   Names of LMP Markets


   **Attributes**

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

      * - **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**

   .. autoapisummary::
      :nosignatures:

      gridstatus.base.Markets.__contains__

   .. py:method:: __contains__(item)



.. py:exception:: NotSupported

   Bases: :py:obj:`Exception`

   Common base class for all non-exit exceptions.

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