Florian 5 years ago
parent
commit
eba9cf534c
1 changed files with 12 additions and 14 deletions
  1. 12 14
      README.md

+ 12 - 14
README.md

@@ -25,23 +25,21 @@ MATSim network files (`.xml`)
     plan_gen_cli.py [ params ] > out_plans.xml
 
 ### 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.
+- `np` : number of persons to generate,
+- `nw` : global network file path,
+- `nc` : number of clusters by axis *(e.g. `nc=100` results in `100 x 100 = 10000` clusters)*,
+- `hc` *(optional)* : home clusters center coordinates (`line:column`). If multiple clusters, separate centers coordinates with `|` symbol (`"line_1:col_1|line_2:col_2|...|line_x:col_x"`),
+- `hr` *(only if `hc` parameter is specified)* : home clusters radii. If multiple clusters, separate radii with `|` symbol (`"rad_1|rad_2|...|rad_x"`),
+- `wc` *(optional)* : work clusters center coordinates (cf. `hc`),
+- `wr` *(only if `wc` parameter is specified)* : work clusters radii (c.f `hr`).
 
 ### examples
 
-generate 1000 persons with totally random home and work locations:
+generate 5000 persons centered in a 100x100 clusters grid (default):
 
-    plan_gen_cli.py np=1000,nw=input/network.xml
+    plan_gen_cli.py np=5000,nw=input/network.xml,nc=100 > out.xml
 
-generate 5000 persons with home locations reparted in 2 clusters *(work locations are totally random)*:
+generate 10000 persons with home locations reparted in 2 clusters of radii 10 and 5, respectively *(work locations are sampled with the default behaviour as above)*:
 
-    plan_gen_cli.py np=5000,nw=input/network.xml,hc=input/c01.xml:input/c02.xml
-
-generate 1000 persons with home and work locations reparted in different clusters:
-
-    plan_gen_cli.py np=1000,nw=input/network.xml,\
-    hc=input/c02.xml:input/c03.xml,\
-    wc=input/c01.xml:input/c04.xml
+    plan_gen_cli.py np=10000,nw=input/network.xml,nc=100,\
+    hc="50:50|67:17",hr="10|5" > out.xml