<commit_before>Consumption data structures
===========================

Overview
--------

Meters are data-source agnostic, but many built in metrics require input data
to be in the `ConsumptionHistory` format. A set of importing tools and examples
simplify the process of creating these python data containers, as consumption
data may originate from a variety of very different sources, including
wirelessly connected smart meters, specially formatted databases, Home
Performance XML, or CSV spreadsheets downloads from energy providers.

API reference
-------------

Consumption is tracked by start and end date, units, usage, and fuel type.

Some fuel types have been built in:

.. autoclass:: eemeter.consumption.FuelType
   :members:

- electricity
- natural_gas
- propane

Instances of the Consumption class generally contain a single meter reading.

.. autoclass:: eemeter.consumption.Consumption
   :members:

The ConsumptionHistory class is created from an array of consumptions of
mixed or single fuel type.

.. autoclass:: eemeter.consumption.ConsumptionHistory
   :members:

TODO
----

Add importers
Add database connections (SEED)
Add numpy array support
Add pandas time series support
<commit_msg>add todo bullets<commit_after>Consumption data structures
===========================

Overview
--------

Meters are data-source agnostic, but many built in metrics require input data
to be in the `ConsumptionHistory` format. A set of importing tools and examples
simplify the process of creating these python data containers, as consumption
data may originate from a variety of very different sources, including
wirelessly connected smart meters, specially formatted databases, Home
Performance XML, or CSV spreadsheets downloads from energy providers.

API reference
-------------

Consumption is tracked by start and end date, units, usage, and fuel type.

Some fuel types have been built in:

.. autoclass:: eemeter.consumption.FuelType
   :members:

- electricity
- natural_gas
- propane

Instances of the Consumption class generally contain a single meter reading.

.. autoclass:: eemeter.consumption.Consumption
   :members:

The ConsumptionHistory class is created from an array of consumptions of
mixed or single fuel type.

.. autoclass:: eemeter.consumption.ConsumptionHistory
   :members:

TODO
----

- Add importers
- Add database connections (SEED)
- Add numpy array support
- Add pandas time series support

{'fraction_non_alphanumeric': 0.0854911631730374, 'fraction_numerical': 0.0, 'mean_word_length': 4.326039387308534, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3168587', 'n_tokens_mistral': 634, 'n_tokens_neox': 584, 'n_words': 292}