Skip to main content

SCENe interfAces for Robot Input/Output.

Project description

ScenarIO

C++ standard Size Lines Python CI/CD

Version Python versions Status Format License

SCENe interfAces for Robot Input / Output.

Description

ScenarIO is a C++ abstraction layer to interact with simulated and real robots.

It mainly provides the following C++ interfaces:

  • scenario::core::World
  • scenario::core::Model
  • scenario::core::Link
  • scenario::core::Joint

These interfaces can be implemented to operate on different scenarios, including robots operating on either simulated worlds or in real-time.

ScenarIO currently fully implements Gazebo ScenarIO, a simulated back-end that interacts with Ignition Gazebo. The result allows stepping the simulator programmatically, ensuring a fully reproducible behaviour. It relates closely to other projects like pybullet and mujoco-py.

A real-time backend that interacts with the YARP middleware is under development.

ScenarIO can be used either from C++ (APIs) or from Python (APIs).

If you're interested to know the reasons why we started developing ScenarIO and why we selected Ignition Gazebo for our simulations, visit the Motivations section of the website.

Installation

ScenarIO only supports a single distribution of the Ignition suite. Visit our Support Policy to check the distribution currently supported.

Then, install the supported Ignition suite following the official instructions.

Python

Execute, preferably in a virtual environment:

pip install scenar-io

C++

You can either clone and install the standalone project:

git clone https://github.com/robotology/gym-ignition
cd gym-ignition/scenario
cmake -S . -B build/
cmake --build build/ --target install

or include it in your CMake project with FetchContent.

Usage

You can find some examples that show the usage of ScenarIO in the Getting Started section of the website.

Contributing

Please visit the Limitations section of the website and check the good first issue and help wanted issues.

You can visit our community forum hosted in GitHub Discussions. Even without coding skills, replying user's questions is a great way of contributing. If you use ScenarIO in your application and want to show it off, visit the Show and tell section!

Pull requests are welcome.

For major changes, please open a discussion first to propose what you would like to change.

Citation

@INPROCEEDINGS{ferigo2020gymignition,
    title={Gym-Ignition: Reproducible Robotic Simulations for Reinforcement Learning},
    author={D. {Ferigo} and S. {Traversaro} and G. {Metta} and D. {Pucci}},
    booktitle={2020 IEEE/SICE International Symposium on System Integration (SII)},
    year={2020},
    pages={885-890},
    doi={10.1109/SII46433.2020.9025951}
} 

License

LGPL v2.1 or any later version.

We vendor some resources from the Ignition code base. For this reason, Gazebo ScenarIO is double-licensed with the Apache License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for scenar-io, version 1.2.3.dev86
Filename, size File type Python version Upload date Hashes
Filename, size scenar_io-1.2.3.dev86-cp38-cp38-manylinux2014_x86_64.whl (4.3 MB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size scenar_io-1.2.3.dev86-cp39-cp39-manylinux2014_x86_64.whl (4.3 MB) File type Wheel Python version cp39 Upload date Hashes View
Filename, size scenar_io-1.2.3.dev86.tar.gz (151.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page