From d981fb4afc02b217c153f363a17c4981bf4fa865 Mon Sep 17 00:00:00 2001 From: Jan Philipp Behrens <80356280+J-Behrens@users.noreply.github.com> Date: Sat, 26 Nov 2022 11:11:57 +0100 Subject: [PATCH] Update README.md --- README.md | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 27bbed7..f5a27ab 100644 --- a/README.md +++ b/README.md @@ -6,27 +6,31 @@ To generate instances use [gen.py](https://github.com/krr-up/mapf-instance-generators/blob/main/gen.py) as follows: ``` -usage: python gen.py (maze | random -c [0-100] | room -w WIDTH | warehouse -w WIDTH) -s SIZE -a AGENTS [-m] [-v] [-h] +usage: python gen.py (maze | random -c [0-100] | room -w WIDTH | warehouse -w WIDTH) -s SIZE -a AGENTS [-d DISTANCE] [-dur MINDUR MAXDUR] [-m] [-v] [-h] + positional arguments: - {maze,random,room,warehouse} + {maze,random,room,warehouse} type of instance to be generated optional arguments: - -h, --help show this help message and exit - --allSPs generates all shortest paths - -d DISTANCE, --distance DISTANCE min. manhatten distance from start to goal - -v, --visualize convert to and visualize with asprilo - -m, --meta gets and adds meta informations + -h, --help show this help message and exit + --allSPs generates all shortest paths for all agents + -d DISTANCE, --distance DISTANCE min. manhatten distance from start to goal + -dur MINDUR MAXDUR, --durations MINDUR MAXDUR generates instances with durations + -m, --meta gets and adds meta informations + -q, --quiet turns on quiet mode + -v, --visualize convert to and visualize with asprilo + -required arguments for all: - -s SIZE, --size SIZE size of instance - -a AGENTS, --agents AGENTS number of agents +required arguments for all instance types: + -s SIZE, --size SIZE size of instance + -a AGENTS, --agents AGENTS number of agents -required arguments for room / warehouse: - -w WIDTH, --width WIDTH width of rooms / shelves +required arguments for room / warehouse type: + -w WIDTH, --width WIDTH width of rooms / shelves -required arguments for random: - -c [0-100], --cover [0-100] percentage of vertices covered +required arguments for random type: + -c [0-100], --cover [0-100] percentage of vertices covered ``` Warning: As the used arguments impact the problem difficulty, long runtime is to be expected e.g. for high values for --size or low values for --cover.