From 3d791bf6af2b3c727c54af65d686194aba653737 Mon Sep 17 00:00:00 2001
From: Pithon Kabiro <pithon.kabiro@hft-stuttgart.de>
Date: Wed, 2 Jun 2021 16:13:33 +0200
Subject: [PATCH] Update README

---
 README.md | 26 +++++++++++++++++++++++---
 1 file changed, 23 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 558e7d2..03a3401 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,24 @@
-# disaggregation
+# Disaggregation algorithm
 
-Source code for disaggregation.
-For the web app implementation, please check the "webapp" branch.
+This disaggregation algorithm enables the coupling of two tools:
+
+- KomMod, an energy optimization tool developed at Fraunhofer ISE;
+- SimStadt, an urban energy simulation platform developed at the Stuttgart University of Applied Sciences.
+
+The combination of these tools results in a framework that allows the study of optimal solutions for the provision of heat to buildings in both urban and rural regions.
+
+For further technical details please refer to this journal article:
+Steingrube, A.; Bao, K.; Wieland, S.; Lalama, A.; Kabiro, P.M.; Coors, V.; Schröter, B. A Method for Optimizing and Spatially Distributing Heating Systems by Coupling an Urban Energy Simulation Platform and an Energy System Model. _Resources_ 2021, 10, 52. https://doi.org/10.3390/resources10050052
+
+## Prerequisites
+
+- Street segments created using [this](https://transfer.hft-stuttgart.de/gitlab/ensource-2/street-segmentation) tool
+
+## Example usage
+
+- Generate disaggregated grid using all of the street segments in the provided street segment file:
+  - `python disaggregation_lookahead.py -s input_segments/rainau_stat_lines_with_industry.csv`
+
+---
+
+For the web app implementation, please check the `webapp` branch.
-- 
GitLab