monthly_energy_balance/README.md

# MonthlyEnergyBalance

This tool calculates the monthly energy balance for each building in a given region.

The following assumptions are taken:
- No building in the region have attics
- All buildings have basement but those are not heated
- The construction details come from nrel
- The usage details come from comnet

#### Dependencies
 
You will need to install the following dependencies in your computer in order to run the software; please take a look at the [install process](#installation) for your system-specific details

##### External software
+ INSEL 8 (https://insel4d.ca/en/download.html)
+ Simplified Radiosity Algorithm (mail to: guillermo.gutierrezmorote@concordia.ca)

After installing these tools you should include their paths in Path.

 ## installation
 
 ##### Linux / Mac
 
 Open a terminal and run the following commands.
 
  ```
$ mkdir MonthlyEnergyBalance
$ cd MonthlyEnergyBalance 
$ git clone https://binarycat.org/git/PMAU/MonthlyEnergyBalance.git
$ python -m pip install requirements.txt
  ```

 ##### Windows
 
 Open a terminal and run the following commands.
 
  ```
c:\> mkdir MonthlyEnergyBalance
c:\> cd MonthlyEnergyBalance 
c:\> git clone https://binarycat.org/git/PMAU/MonthlyEnergyBalance.git
c:\> python.exe -m pip install requirements.txt
  ```
  
 

 
 #### usage
 
 ##### Linux / Mac
 
 Open a terminal and run the following command
 
  ```
$ python main.py
  ```

 ##### Windows
 
 Open a terminal and run the following command.
 
  ```
c:\> python.exe main.py
  ```