Giter VIP home page Giter VIP logo

smartmeter-analyze's Introduction

README

This Tool was written to analyze your personal energy consumption.

The Tool currently only supports CSV files with daily consumption values, as provided by the 'Smart Metering' service of 'Wiener Netze GmbH'.

Features

  • Generation of basic consumption summaries (averages, peaks, etc.)
  • Basic consumption prediction
  • Handling of one or many (not necessarily disjunct) datasets

Installation

$ pip install smartmeter-analyze

You can also run the application as a Docker container:

$ make run

This will build and run a container with the web interface of the application. In this case you can access the application over port 80 of the containers host.

Requirements

smartmeter-analyze uses the following libraries:

  • pandas
  • numpy

In order to use the web interface additional libraries are needed:

  • flask
  • docutils

Usage

Print a statistical summary of your energy consumption:

$ smutil summary consumption-file.csv

Print the summary, using multiple files or directories:

$ smutil summary ~/some_dir_with_consumption_files/ another-file.csv

You can download your energy consumption data from smartmetering.wienernetze.at

To start the web interface, run:

$ smutil run_webutil

or for the container version:

$ make run

The interface is accessible with this URL:

http://localhost:5000/analyze

If you run the application in the Docker container you can use port 80 on the containers host. To stop and remove the container use:

$ make clean

Screenshots

doc/screenshots/webutil_index.png

doc/screenshots/webutil_upload.png

TODO

  • More sophisticated summaries
  • import/storage of data
  • Report generation
  • integration of pricing (energy only)

Credits

Icon

The Icon was composed by the following pictograms:

  • Graph designed by Pham Thi Dieu Linh from the thenounproject.com
  • Socket designed by hunotika from the thenounproject.com

Themes/Stylesheets

smartmeter-analyze's People

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

ehameyie

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.