socialgym2

SocialGym 2: A lightweight benchmark and simulator for multi-robot social navigation using ROS and the OpenAI gym.

https://github.com/ut-amrl/socialgym2

Science Score: 57.0%

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

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 1 DOI reference(s) in README
  • Academic publication links
    Links to: arxiv.org
  • Academic email domains
  • Institutional organization owner
    Organization ut-amrl has institutional domain (amrl.cs.utexas.edu)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.8%) to scientific vocabulary

Keywords

multi-agent-reinforcement-learning multi-robot-systems pettingzoo robotics simulator social-navigation social-navigation-simulator stable-baselines3
Last synced: 6 months ago · JSON representation

Repository

SocialGym 2: A lightweight benchmark and simulator for multi-robot social navigation using ROS and the OpenAI gym.

Basic Info
Statistics
  • Stars: 59
  • Watchers: 5
  • Forks: 6
  • Open Issues: 0
  • Releases: 1
Topics
multi-agent-reinforcement-learning multi-robot-systems pettingzoo robotics simulator social-navigation social-navigation-simulator stable-baselines3
Created over 4 years ago · Last pushed almost 2 years ago
Metadata Files
Readme Contributing License Citation

README.md

<!--

SocialGym 2

-->

This is the codebase for our multi-agent simulator for real world social navigation. Installation instructions ca be found below. Tutorials are provided in the documentation (currently under active development).

Read the paper

SOCIALGYM 2.0: Simulator for Multi-Agent Social Robot Navigation in Shared Human Spaces, AAAI 2024.

Installation

Prerequisites

You need to have installed Docker and have a GPU.

WARNING: The authors of this project have had numerous issues with Docker and Docker-Compose when installed via snap. We recommend uninstalling docker and docker-compose if you have GPU-related issues with the docker images and installing them via apt.


1.) Clone the repo and checkout main

shell git clone git@github.com:ut-amrl/SocialGym2.git git checkout main

2.) Install requirements and run the install script

shell python3 ./scripts/install_config_runner.py

3.) Run the Config Runner!

shell python3 config_runner/run.py -c 1_31_23/door/sacadrl.json

This should open an RVIS window (looks like a 2D grid with options on the side-panels). If you do NOT see this window, there's a problem with the docker file. First try running shell sudo xhost + and repeat the command. If it still fails to show windows then try adding --network host to the file {PROJECT_ROOT}/config_runner/run.sh on lines where we are setting docker environment variables. Otherwise, look up stuff like "cannot display window from docker container" -- this is critical for Social Gym to work.

3.) Have fun!

If you use this code, please cite the following


@inproceedings{chandra2024socialgym, title={SOCIALGYM 2.0: Simulator for Multi-Robot Learning and Navigation in Shared Human Spaces}, author={Chandra, Rohan and Sprague, Zayne and Biswas, Joydeep}, booktitle={Proceedings of the AAAI Conference on Artificial Intelligence}, volume={38}, number={21}, pages={23778--23780}, year={2024} }

@inproceedings{holtz2022socialgym, title={Socialgym: A framework for benchmarking social robot navigation}, author={Holtz, Jarrett and Biswas, Joydeep}, booktitle={2022 IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS)}, pages={11246--11252}, year={2022}, organization={IEEE} }

License


This project is released under the MIT License. Please review the License file for more details.

Owner

  • Name: Autonomous Mobile Robotics Laboratory
  • Login: ut-amrl
  • Kind: organization
  • Location: Austin, Texas, USA

GitHub Events

Total
  • Watch event: 8
Last Year
  • Watch event: 8

Dependencies

.github/workflows/documentation.yaml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • peaceiris/actions-gh-pages v3 composite
config_runner/Dockerfile docker
  • ros noetic build
docker/vectordisplay/Dockerfile docker
  • ros noetic build
requirements.txt pypi
  • tqdm *