The C++ code for my Computing MSc energy disaggregation project
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config
data
doc
src
tests
.gitignore
Makefile
README.md

README.md

The code for my 2011 MSc thesis. The thesis can be downloaded from http://jack-kelly.com/files/writing/d_kelly_MSc_thesis.pdf

DEPENDENCIES

1. Doxygen (developed against version 1.7.3)
2. Boost   (developed against version 1.42.0.1)
 | 
 +--- Boost String Algorithms Library
 |        http://www.boost.org/doc/libs/1_42_0/doc/html/string_algo.html
 |        
 +--- Boost Graph Library
 |        http://www.boost.org/doc/libs/1_42_0/libs/graph/doc/index.html
 |         
 +--- Boost Unit Test Framework
 |         http://www.boost.org/doc/libs/1_42_0/libs/test/doc/html/index.html
 |         
 \--- Boost Program Options
           http://www.boost.org/doc/libs/1_42_0/doc/html/program_options/
           Must be compiled from source and explicitly linked to.
           Details:
              http://www.boost.org/doc/libs/1_42_0/more/getting_started/unix-variants.html#easy-build-and-install
              http://www.boost.org/doc/libs/1_42_0/more/getting_started/unix-variants.html#link-your-program-to-a-boost-library

DOCUMENTATION

HTML documentation is available online.

To compile the documentation youself:

  1. change directory to doc/
  2. run 'doxygen' (you may have to install doxygen first! It is available from doxygen.org )
  3. Now point a web browser at doc/html/index.html

LICENSE

MIT License

Copyright (c) 2011 Jack Kelly

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.