From e2146e3f3d1ee95c7242a4d56e6cb545ed97c7d9 Mon Sep 17 00:00:00 2001
From: CAPELLE Thomas <thomas.capelle@inria.fr>
Date: Fri, 4 May 2018 15:00:13 +0200
Subject: [PATCH] readme re0added
---
README.md | 140 +++++-------------------------------------------------
1 file changed, 11 insertions(+), 129 deletions(-)
diff --git a/README.md b/README.md
index 83c906d..e5f4ade 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,7 @@ Details on the mathematics of the Tranus implementation and Python Tranus con be
## Getting Started
### Prerequisites
-This program is a Python module, the following python packages are required [requirements.txt](requirements.txt):
+This program is a Python module, the following python packages are required:
* numpy
* pandas
* scipy
@@ -20,136 +20,18 @@ This program is a Python module, the following python packages are required [req
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```
-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.
-
- ```
- 1, 2
- 2, 1
- 3, 5
- ```
-
-This adjacency list is constructed from the data from the shapefile of the visum network.
-
-* The Tranus Network:
- This file is constructed based on the Tranus network and the nodes that have a Visum id. To build this network, you will need to supply the Tranus .links file. The supplied file is [NEW-00A.links](NEW-00A.links). You will also need to supply a correspondance file, to identify wich Tranus nodes have a Visum ID. This file can be created using Joint in excel, or map in python, between Tranus .nodes file and the description column. The supplied file is [biyection_tranus_visum.csv](biyection_tranus_visum.csv), this file is just a csv with two columns, establishing the biyection between the Tranus ID/Visum ID of the nodes.
-
- ```
- Tranus ID, Visum ID
- 1 , 1
- 2 , 2
- 3 , 4
- ```
-
-* Assignement File [assignement_fausto.csv](assignement_fausto.csv):
- This file is the assignement output from Tranus. The script will convert the Tranus id of nodes to the nodes with the visum jointure using the biyection file.
-
-### Running the code:
-First verify that you have all required files listed in [input_files.py](input_files.py) in the [Input_Files](Input_Files) folder.
-To run the program, you will need to execute the script atmo.py using python (you can also do ipython >> run atmo.py).
-
-```
->> python atmo.py
-Biyection read succesfully from file: Input_Files/biyection_tranus_visum.csv
-Tranus network read succesfully from file: Input_Files/tranus_visum_attributes.csv
-Tranus assisgnement file read succesfully: Input_Files/assignement_fausto.csv
-Reading Visum network from: Input_Files/adj_visum2015.csv
-Warning: There is (are) 1 node(s) that do not have a visum ID
- The followgin Tranus nodes do not have a Visum Id:
- 3657,
- Removing nodes { 3657, } from the Tranus graph.
-Enter Operator Name(V-Voiture, Ve-Velo, P-Pietons, Poids Lurds, B-Bus urbain, C-Car, N-Navettes, S-Tramway, Bplus_BHNS, Cplus-Car Exp, T-Train
-OperName >>
-```
-
-You have to input the name of the desired operator, if None, Voiture is selected.
-
-```
-Voiture automatically selected.
-Edges not found in the Tranus Network:
- (31, 108143447)
- (196, 108130136)
- (229, 108129510)
- (341, 108142226)
- (11631, 108123957)
- (11677, 108118545)
- (11754, 108118686)
- (12247, 108125304)
- (13437, 13446)
- (13446, 13437)
- (13607, 108142473)
- (13941, 108125338)
- (108118545, 11677)
- (108118686, 11754)
- (108118984, 108125784)
- (108123258, 108125410)
- (108123957, 11631)
- (108125304, 12247)
- (108125338, 13941)
- (108125410, 108123258)
- (108125784, 108118984)
- (108126285, 108126289)
- (108126289, 108126285)
- (108126289, 108126354)
- (108126354, 108126289)
- (108126517, 108126600)
- (108126600, 108126517)
- (108128369, 108135985)
- (108128549, 108128804)
- (108128745, 108128853)
- (108128787, 108128851)
- (108128804, 108128549)
- (108128851, 108128787)
- (108128851, 108128853)
- (108128853, 108128745)
- (108128853, 108128851)
- (108129510, 229)
- (108129739, 108129858)
- (108129813, 108129694)
- (108129889, 108129973)
- (108129994, 108129889)
- (108130075, 108130198)
- (108130976, 108131010)
- (108132533, 108132549)
- (108132685, 108132720)
- (108132834, 108132799)
- (108135985, 108128052)
- (108136275, 108137314)
- (108137387, 108137390)
- (108137390, 108137387)
- (108142226, 341)
- (108142473, 13607)
- (108143447, 31)
- (108144466, 108144505)
- (108144505, 108144466)
- (108144508, 108144510)
- (108144874, 108144885)
- (108144885, 108144874)
- (109227060, 109227064)
- (109227064, 109227060)
- (109230732, 109230880)
- (109230816, 109230880)
- (109230880, 109230732)
- (109230880, 109230816)
- (109230880, 109230899)
- (109230880, 109231138)
- (109230899, 109230880)
- (109231138, 109230880)
- Output file: proyection_visum.csv
- ```
-
- Edges not present in the Tranus network are listed (it is normal, as there are assignements between some nodes without Visum ID). The output file is then written in [proyection_visum.csv](proyection_visum.csv)
-
+
+
+
+
+
+
+
## Authors
@@ -157,8 +39,8 @@ Edges not found in the Tranus Network:
## License
-This project is licensed under the MIT License
+This project is licensed under some License
## Acknowledgments
-* Thank you Fausto Lo Feudo
+* Thank you Fausto Lo Feudo / Brian Morton / Peter Sturm / Arthur Vidard / Tomas de la Barra
--
GitLab