Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shchan13 committed Aug 28, 2023
1 parent e9d9b98 commit c5d03bb
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@ The primary purpose of PlanViz is to better understand how robots/agents move ac
The scenario on the left of PlanViz shows how the agents move in the environment and how the tasks are allocated at each timestep.
- The map is plotted in grids with the white ones being the free spaces and black ones being obstacles.
- An agent is plotted in a blue circle, with a number being the agent index and a darkblue dot being its heading.
- A task is plotted in a colored square with a number being the task index. Each task is initially marked in pink, and turns orange when it is assigned to an agent and grey when it is completed.
- A task is plotted in a colored square with a number being the task index. Each task is initially marked in pink, and turns yellowgreen when it is newly assigned to an agent, orange after it is assigned to an agent, and grey when it is completed.
- When PlanViz is in fullsize, right-click an agent to see/hide its path. The paths are presented with a sequence of purple squares, with the locations where the agent rotates or waits being larger.

![scenario](images/scenario.png)

## User Interface
The user interface provides operations for user to control the scenario.
- `Timestep` shows the current timestep.
Expand All @@ -31,9 +33,6 @@ The user interface provides operations for user to control the scenario.
- A vertex/edge collision between agents $a_i$ and $a_j$ at location $V$/edge $(U,V)$ at timestep $T$ is presented under the format of `ai, aj, v=V/e=(U,V), t=T`. Single-click the collision in `List of errors` can mark the colliding agents in red, and press `ctrl` while clicking to select multiple collisions. See agents 19 and 22 in the following figure for example.
- `List of events` contains information of task assignments and task completion. When the scenario is paused, you can *double-click* an event to move all the agents to one timestep before such event occurs.

![scenario](images/scenario.png)


## Arguments
- `--map` (type: *str*): Path to the map file (ends with `.map`). See `example/warehouse-small.map` for more information.
- `--plan` (type: *str*): Path to the planned path file (ends with `.json`). See `example/warehouse-small-60.json` for more information.
Expand Down

0 comments on commit c5d03bb

Please sign in to comment.