************
Installation
************

Overview
========

EnergyBoost is python-based and you can easily install all required library through
`pip install` or `conda install` for conda users.

Pre-request: `Python 3.4+ <https://www.python.org/downloads/>`_.

Required Packages and versions
====================================
==============     ==========
  A                  B
==============     ==========
pandas             0.23.0
numpy              1.14.2
pvlib              0.5.2
matplotlib         2.1.2
scikit-learn       0.20.2
tensorflow-gpu     1.12.0
cxvpy              1.0.6
gurobipy           8.1.0
gym                0.10.5
==============     ==========




Via Git or Download
-------------------

If you want the latest version, you can clone our `GitHub repository <https://github.com/sustainable-computing/EnergyBoost.git>`_.

1. Install Git on your computer::

    $ sudo apt-get install git

2. Check and clone the latest version of EnergyBoost::

    $ git clone https://github.com/sustainable-computing/EnergyBoost.git

3. Install requirements::

    $ cd ./EnergyBoost/Scripts
    $ ./installation.sh