Installation

1. Download the code from Github
2. We highly recommend to use an Anaconda distribution

1. download and install Anaconda for Python 2.7 and your specific OS.
2. Create one environement for this project

conda create --name microgrid --file conda-{platform}.txt

where “{platform}” must match your OS. Checkout this reference for more information about how to manage Anaconda environments.

3. Activate the environment

For Windows:

activate microgrid

For OSX and Linux,

source activate microgrid

Running the application

Please refer to the examples

• Examples
  • Toy example: running an idle controller on case 1
  • Case 1 description

Documentation

Read the doc for more information.

Alternatively you can generate the documentation yourself if you have sphinx installed:

cd <to the root of the project>
sphinx-apidoc -o docs/ microgrid/ -f --separate
cd docs; make html; cd ..

The html doc is in _build/html