Florian il y a 6 ans
Parent
commit
61aa6a5424
1 fichiers modifiés avec 23 ajouts et 6 suppressions
  1. 23 6
      README.md

+ 23 - 6
README.md

@@ -1,6 +1,6 @@
 # plan_gen
 
-Python generator for MATSim plans.
+Python generator for MATSim random plans.
 
 ## setup
 
@@ -20,11 +20,28 @@ MATSim network files (`.xml`)
 
 ## usage
 
+### run
+
     plan_gen.py [ params ] > out_plans.xml
 
-## todo
+###params list
+- `np` : number of persons to generate
+- `nw` : global network file path
+- `hc` *(optional)* : home clusters network file paths. If multiple cluster files, separate paths with `:` symbol (`path1:path2:...:pathx`).
+- `wc` *(optional)* : work clusters network file paths. If multiple cluster files, same as  `hc` parameter.
+
+### examples
+
+generate 1000 persons with totally random home and work locations:
+
+    plan_gen.py np=1000,nw=input/network.xml
+
+generate 5000 persons with home locations reparted in 2 clusters *(work locations are totally random)*:
+
+    plan_gen.py np=5000,nw=input/network.xml,hc=input/hc_01.xml:input/hc_02.xml
+
+generate 1000 persons with home and work locations reparted in different clusters:
 
-params
-readme
-input test files
-test clusters
+    plan_gen.py np=1000,nw=input/network.xml, \ 
+    hc=input/hc_01.xml:input/hc_02.xml, \
+    wc=input/wc_01.xml:input/wc_02.xml