Giter Club home page Giter Club logo

nilmtk's Introduction

nilmtk: Non-Intrusive Load Monitoring Toolkit

Non-Intrusive Load Monitoring (NILM) is the process of estimating the energy consumed by individual appliances given just a whole-house power meter reading. In other words, it produces an (estimated) itemised energy bill from just a single, whole-house power meter.

NILM is sometimes called:

  • "non-intrusive appliance load monitoring (NALM or NIALM)"
  • "[electriciy | energy | smart meter] disaggregation"

Below is an illustration1 of what NILM, in general, can do.

Drawing

NILMTK Documentation

http://nilmtk.github.io/nilmtk/

Current state of the project

The project is in its early stages.

At present, NILMTK can:

  • import data from the following data sets: REDD, Pecan Street, AMPds, iAWE, SMART* and UKPD
  • store imported data in a common in-memory format, which can also be exported to a standard on-disk format
  • compute diagnostic statistics for the raw data (uptime, dropout rate, find gaps etc)
  • pre-process the data (downsample, fill gaps, mask appliance data with gaps from the mains data, select only contiguous blocks, normalise power etc)
  • compute usage statistics (distribution of appliance activity per day, week or month, distribution of on-power, proportion of total energy per appliance, on-durations etc)
  • provide a common input and output interface to NILM algorithms
  • disaggregate data using two supervised benchmark algorithms: combinatorial optimisation and factorial hidden Markov model (these are not competitive with the current state-of-the-art. More sophisticated NILM algorithms will be added to NILMTK later this year.)
  • compute a range of NILM performance metrics (confusion matrices, error in assigned energy, F1 score, fraction of energy assigned correctly etc).
  • work has started on a disaggregation web interface. Here's a demo.
Installing

If you just want to use the code without modifying it then:

python setup.py install

(you may have to run as sudo)

If you want to get involved in development then:

python setup.py develop

Software Dependencies
  1. Pandas
  2. matplotlib
  3. numpy => 1.8
  4. scikit-learn > 0.13
Getting started

Loading a supported dataset is simple. For example, to load REDD:

from nilmtk.dataset import REDD
redd = REDD()
redd.load('/data/REDD/low_freq/')

Please see the examples folder for further information on getting started.

We have started writing a user guide although it is by no means complete yet. A full user guide will be written in February.

We also have API documentation. This documentation covers almost all functions in NILMTK but needs some tidying up which will be done over February.

Further info

Please see the nilmtk wiki for more details.

Development plans for February and March:
Notes
  1. The image is from the following paper and since the main author is contributing to nilmtk, so no permission issues. The reference is: Nipun Batra, Haimonti Dutta, Amarjeet Singh, “INDiC: Improved Non-Intrusive load monitoring using load Division and Calibration”, to appear at the 12th International Conference on Machine Learning and Applications (ICMLA’13) will be held in Miami, Florida, USA, December 4 – December 7, 2013 Preprint. IPython notebook

nilmtk's People

Contributors

jackkelly avatar magusverma avatar nipunbatra avatar oliparson avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.