You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Jim Paris 7bed742957 Add nilm-sinefit test, and update for Python 3 1 year ago
extras Set shell and path in sample cron script 8 years ago
nilmtools Add nilm-sinefit test, and update for Python 3 1 year ago
tests Add nilm-sinefit test, and update for Python 3 1 year ago
.coveragerc Add test framework, and initial test for nilm-copy 1 year ago
.gitattributes Large restructuring, added setup 8 years ago
.gitignore Use multiprocessing to start multiple servers in tests 1 year ago
MANIFEST.in Start Python 3 conversion 1 year ago
Makefile Start Python 3 conversion 1 year ago
README.md Start Python 3 conversion 1 year ago
requirements.txt Start Python 3 conversion 1 year ago
setup.cfg Start Python 3 conversion 1 year ago
setup.py Start Python 3 conversion 1 year ago
versioneer.py Start Python 3 conversion 1 year ago

README.md

nilmtools: Tools and utilities for NilmDB

Tools and utilities for interacting with the NILM Database, or writing programs that interact with the NILM database.

by Jim Paris jim@jtan.com

Prerequisites:

# Runtime and build environments
sudo apt-get install python3

# Create a new Python virtual environment to isolate deps.
python3 -m venv ../venv
source ../venv/bin/activate   # run "deactivate" to leave

# Install all Python dependencies
pip3 install -r requirements.txt

Install:

Install it into the virtual environment

python3 setup.py install

If you want to instead install it system-wide, you will also need to install the requirements system-wide:

sudo pip3 install -r requirements.txt
sudo python3 setup.py install

Building new tools:

The tools in this package are meant to be installed with python3 setup.py install. If you want to make a new one, an easier way to develop would be to first install this package, and then copy a specific script like src/sinefit.py to a new location, and modify it as desired.

To add a tool to the package, place it in src/ and add the appropriate configuration to setup.py.