From 9f51727af0ff7172ca5f9e0089b41cba51e54bcc Mon Sep 17 00:00:00 2001
From: CAPELLE Thomas <thomas.capelle@inria.fr>
Date: Thu, 3 May 2018 21:33:24 +0200
Subject: [PATCH] readme re0added

---
 README.md | 24 ++++++++++++++++++------
 1 file changed, 18 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 1df2dc3..83c906d 100644
--- a/README.md
+++ b/README.md
@@ -2,22 +2,34 @@
  
 This project aims to implement the Tranus (http://www.tranus.com/tranus-english/download-install) software in Python. To the current date, only the Lcan Use Calibration (LCAL) module is available. This implementation integrates with the other Tranus modules, and can be used as an standalone program.
 
-The main features of this program, is that the implementation is different of the original Tranus software, reformulating the whole calibration as an optimisation problem. Details on the mathematics of the Tranus implementation and Python Tranus con be found here:
-*[Detailed scientific article](https://www.sciencedirect.com/science/article/pii/S0198971517302181?via%3Dihub)
+The main features of this program, is that the implementation is different from the original Tranus software, reformulating the whole calibration as an optimisation problem. The internal parameters are computed minimising a cost function enabling semi-automatic parameter calibration.
+Details on the mathematics of the Tranus implementation and Python Tranus con be found here:
+* Detailed scientific [article](https://www.sciencedirect.com/science/article/pii/S0198971517302181?via%3Dihub) about the Tranus Python implementation.
+* [Mathematical description](http://docs.google.com/viewer?a=v&pid=sites&srcid=ZGVmYXVsdGRvbWFpbnx0cmFudXNtb2RlbHxneDo3YWQzYTk0OTkxN2RlN2Rj) of the Tranus software implementation.
+
 
 
 ## Getting Started
 
 ### Prerequisites
-The script is in python language, and needs the following python dependencies: 
+This program is a Python module, the following python packages are required [requirements.txt](requirements.txt):
 * numpy
 * pandas 
-* networkx.
+* scipy
+* cython
+
+It is recommended to install anaconda python : https://anaconda.org/anaconda/python and you are good.
+If you don't use anaconda, you can also install using the supplied [setup.py](setup.py) doing:
+```python setup.py --install```
+
+
 
-(just install  anaconda python : https://anaconda.org/anaconda/python and you are good)
-	
 Various input files are needed to execute the script. These files are located in the [Input_Files](Input_Files) folder. The paths to the input files must be entered in the [input_files.py](input_files.py) file.
 
+This program is a Python module, that can be installed and used with command 
+```import pytranus```
+
+
 * The Visum Network [adj_visum2015.csv](adj_visum2015.csv): 
 	You wil need the Visum network in the form of an adjacency list, this is a file containing a list of edges.
 	
-- 
GitLab