mapf-visualizer

simple multi-agent pathfinding (MAPF) visualizer for research usage

https://github.com/kei18/mapf-visualizer

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.7%) to scientific vocabulary

Keywords

mapf multi-agent-path-finding visualizer
Last synced: 6 months ago · JSON representation ·

Repository

simple multi-agent pathfinding (MAPF) visualizer for research usage

Basic Info
  • Host: GitHub
  • Owner: Kei18
  • License: mit
  • Language: C++
  • Default Branch: master
  • Homepage:
  • Size: 10.2 MB
Statistics
  • Stars: 66
  • Watchers: 1
  • Forks: 15
  • Open Issues: 1
  • Releases: 0
Topics
mapf multi-agent-path-finding visualizer
Created over 3 years ago · Last pushed over 1 year ago
Metadata Files
Readme Citation

README.md

Logo # mapf-visualizer [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE) [![ci](https://github.com/Kei18/mapf-visualizer/actions/workflows/ci.yml/badge.svg)](https://github.com/Kei18/mapf-visualizer/actions/workflows/ci.yml) Simple & scalable multi-agent pathfinding (MAPF) visualizer for research usage. Based on [openFrameworks](https://openframeworks.cc/), written in C++14.

Demo

room-32-32-4

tunnel, planning with four agents

ost003d, planning with 1000 agents

Install

for macOS

sh git clone --recursive https://github.com/Kei18/mapf-visualizer.git cd mapf-visualizer bash third_party/openFrameworks/scripts/osx/download_libs.sh make -j4 echo -e "\nexport PATH=$(pwd)/bin/mapf-visualizer.app/Contents/MacOS:\$PATH" >> ~/.bashrc

required: around 10 minutes

for Ubuntu 24.04

sh git clone https://github.com/Kei18/mapf-visualizer.git cd mapf-visualizer wget -O third_party/openFrameworks.tar.gz https://github.com/openframeworks/openFrameworks/releases/download/0.12.0/of_v0.12.0_linux64gcc6_release.tar.gz tar -xzvf third_party/openFrameworks.tar.gz -C third_party --strip-components=1 --one-top-level=openFrameworks sudo third_party/openFrameworks/scripts/linux/ubuntu/install_dependencies.sh sudo third_party/openFrameworks/scripts/linux/ubuntu/install_codecs.sh make -j4 echo -e "\nexport PATH=$(pwd)/bin:\$PATH" >> ~/.bashrc

If you use ZSH

Replace the last line with the following: sh echo -e "\nexport PATH=$(pwd)/bin/mapf-visualizer.app/Contents/MacOS:\$PATH" >> ~/.zshrc

sh echo -e "\nexport PATH=$(pwd)/bin:\$PATH" >> ~/.zshrc

for other Linux

I heard that the visualizer worked on (Arch) Linux. To install, try install_linux.sh. You may need sudo.

Note

The changes will be applied after you restart your terminal. To apply the changes immediately, run source ~/.bashrc or source ~/.zshrc.

Usage

sh mapf-visualizer assets/random-32-32-20.map assets/demo_random-32-32-20.txt

You can manipulate it via your keyboard. See printed info.

Orientation

The agent orientation is supported, thanks to @JustinShetty. Try:

sh mapf-visualizer assets/2x2.map assets/demo_2x2.txt

Input format of planning result

e.g., txt 0:(5,16),(21,29),[...] 1:(5,17),(21,28),[...] [...]

(x, y) denotes location. (0, 0) is the left-top point. (x, 0) is the location at x-th column and 1st row.

Notes

  • Please specify correct files. I omitted error handling
  • The grid maps in assets/ are from MAPF benchmarks
  • The font in visualizer/bin/data is from Google Fonts
  • This repo is forked from a series of my previous studies such as pibt2, mapf-IR, otimapp, etc. This repo is compatible with lacam, tswap, pypibt, etc.
  • Install pre-commit: sh pre-commit install
  • I'm happy if this repo helps somebody. Please use "Cite this repository" on this page for citation.

Licence

This software is released under the MIT License, see LICENSE.txt.

Maintainer

Keisuke Okumura

Owner

  • Name: Keisuke Okumura
  • Login: Kei18
  • Kind: user
  • Location: Cambridge, UK

multi-agent & multi-robot

Citation (CITATION.cff)

cff-version: 1.2.0
title: "mapf-visualizer"
abstract: Simple multi-agent pathfinding (MAPF) visualizer for research usage
authors:
  - family-names: Okumura
    given-names: Keisuke
    orcid: https://orcid.org/0000-0002-9491-7367
version: 0.1.0
date-released: 2022-08-27
license: MIT
repository-code: "https://github.com/Kei18/mapf-visualizer"

GitHub Events

Total
  • Issues event: 3
  • Watch event: 26
  • Delete event: 1
  • Issue comment event: 14
  • Push event: 2
  • Pull request event: 8
  • Fork event: 4
  • Create event: 1
Last Year
  • Issues event: 3
  • Watch event: 26
  • Delete event: 1
  • Issue comment event: 14
  • Push event: 2
  • Pull request event: 8
  • Fork event: 4
  • Create event: 1

Dependencies

.github/workflows/ci.yml actions
  • actions/checkout v2 composite