from __future__ import print_function, division
from collections import namedtuple, OrderedDict
import pandas as pd
from .metergroup import MeterGroup
from .datastore.datastore import join_key
from .hashable import Hashable
BuildingID = namedtuple('BuildingID', ['instance', 'dataset'])
[docs]class Building(Hashable):
"""
Attributes
----------
elec : MeterGroup
metadata : dict
Metadata just about this building (e.g. geo location etc).
See http://nilm-metadata.readthedocs.org/en/latest/dataset_metadata.html#building
Has these additional keys:
dataset : string
"""
def __init__(self):
self.elec = MeterGroup()
self.metadata = {}
[docs] def save(self, destination, key):
destination.write_metadata(key, self.metadata)
self.elec.save(destination, join_key(key, 'elec'))
@property
[docs] def identifier(self):
md = self.metadata
return BuildingID(instance=md.get('instance'),
dataset=md.get('dataset'))
[docs] def describe(self, **kwargs):
"""Returns a Series describing this building."""
md = self.metadata
series = pd.Series(name=self.identifier.instance)
for key in ['instance', 'building_type',
'construction_year', 'energy_improvements', 'heating',
'ownership', 'n_occupants', 'description_of_occupants']:
series[key] = md.get(key)
series = pd.concat([series, self.elec.describe(**kwargs)])
return series