Florian 7 anni fa
parent
commit
f415596cd0
1 ha cambiato i file con 18 aggiunte e 8 eliminazioni
  1. 18 8
      README.md

+ 18 - 8
README.md

@@ -2,19 +2,29 @@
 
 Python generator for MATSim plans.
 
+## setup
+
+use `venv` (https://github.com/juliendehos/venv)
+
 ## prerequisites
 
-**python libraries :**
-- numpy
-- lxml
+MATSim network files (`.xml`)
+*(test files are available in `input/` folder)*
+
+## install
 
-**input data :**
-- MATSim network file (.xml)
+    venv i plan_gen
+    venv a plan_gen
+    pip install pkgconfig setuptools
+    pip install . --upgrade
 
 ## usage
 
-    ./plan_gen.py <network_file> <nb_persons>
+    plan_gen.py [ params ] > out_plans.xml
 
-You should redirect the generated plans in a separate file :
+## todo
 
-    ./plan_gen.py <network_file> <nb_persons> > out_plans.xml
+params
+readme
+input test files
+test clusters