:mod:`pyaeso.ets` --- Deprecated
==============================================================

.. automodule:: pyaeso.ets
   :synopsis: Energy Trading System Access Made Easier

The :mod:`pyaeso.ets` module defines the following functions:


.. autofunction:: urlopen_pool_price


.. autofunction:: dump_pool_price(f_out, start_date = datetime.date(1995, 1, 1), end_date = datetime.date.today() + datetime.timedelta(1))


.. autofunction:: parse_pool_price_file


.. autofunction:: urlopen_asset_list


.. autofunction:: dump_asset_list


.. autofunction:: parse_asset_list_file


.. autofunction:: urlopen_marginal_pool_price


.. autofunction:: dump_marginal_pool_price(dst, start_date = datetime.date(1999, 10, 1), end_date = datetime.date.today() + datetime.timedelta(1))


.. autofunction:: parse_marginal_pool_price_file


.. class:: QpPoint

   Represents the market equilibrium at a given point in time.


   .. attribute:: QpPoint.t

      UTC localized time at which *price* and *demand* are valid.
      Normally this time should be localized to Alberta Mountain
      Standard Time before being displayed to the user.
      (@type datetime.datetime)

      Usage Example::

	# QpPoint object *qp* as yielded by parse_pool_price_file method
	qp.t.astimezone(ets.ALBERTA_TZ)`


   .. attribute:: QpPoint.price

      Power price in CDN$/MW (@type Decimal).


   .. attribute:: QpPoint.demand

      Power demand in megawatts (MW) (@type Decimal).



.. class:: AssetType

   An enumeration of asset types.

   .. versionadded:: 0.2

   .. attribute:: AssetType.SOURCE

   .. attribute:: AssetType.SINK


.. class:: AssetStatus

   An enumeration of asset status'.

   .. versionadded:: 0.2

   .. attribute:: AssetStatus.ACTIVE

   .. attribute:: AssetStatus.INACTIVE

   .. attribute:: AssetStatus.RETIRED

   .. attribute:: AssetStatus.SUSPENDED


.. class:: Asset

   .. method:: __init__(self, asset_name, asset_id, asset_type, status, participant_name, participant_id)
      Representation of an asset.

   .. versionadded:: 0.2

   .. attribute:: Asset.asset_name

      (@type str)

   .. attribute:: Asset.asset_id

      (@type str)

   .. attribute:: Asset.asset_type

      A value from :class:`AssetType` enumeration.

   .. attribute:: Asset.status

      A value from :class:`AssetStatus` enumeration.

   .. attribute:: Asset.participant_name

      (@type str)

   .. attribute:: Asset.participant_id

      (@type str)



.. class:: PPoint

    A price at a given point in time.

    Since PPoint objects will iterate over their properties t, and
    price, they can be unpacked as in the example.  Also of note is
    that the time, *t*, attribute is normally stored in UTC and is
    normally converted to Alberta's timezone before display.

    .. versionadded:: 0.4

    Usage example::

        >>> from datetime import datetime
        >>> from pyaeso import ets
        >>>
        >>> point = PPoint(datetime(2010, 2, 12, 10, 36), 4.56)
        >>> t, price = point
        >>> t.astimezone(ets.ALBERTA_TZ)

    .. attribute:: PPoint.time

        This is a UTC time and so normally must be converted to
        Alberta's timezone before display.


      (@type datetime.datetime).

    .. attribute:: PPoint.price

      (@type Decimal).