This release is a pre-release and may not be stable for production use.
ScenarIO
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::Worldscenario::core::Modelscenario::core::Linkscenario::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 scenario
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.
1 maintainer
Metadata
1 maintainer
Release files for scenario 1.2.3.dev129
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| scenario-1.2.3.dev129.tar.gz | 150.6 kB | Details |
Built distributions (wheels)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| scenario-1.2.3.dev129-cp39-cp39-manylinux2014_x86_64.whl | CPython 3.9 | CPython 3.9 | Linux glibc 2.17+ x86-64 | Details |
| scenario-1.2.3.dev129-cp38-cp38-manylinux2014_x86_64.whl | CPython 3.8 | CPython 3.8 | Linux glibc 2.17+ x86-64 | Details |
Total release size: 8.5 MB
Release files / scenario-1.2.3.dev129.tar.gz
| Download URL | scenario-1.2.3.dev129.tar.gz |
|---|---|
| Size | 150.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bcd1007bd50380e15b079ba12747c608a11332e45977478130a1e295b0ec0416
|
|
BLAKE2b-256 checksum How to use checksums |
700d2dc759e47a45849c305e083fa0ccce3c79c6f70acbded39b87f5f7b786a7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6
|
Release files / scenario-1.2.3.dev129-cp39-cp39-manylinux2014_x86_64.whl
| Download URL | scenario-1.2.3.dev129-cp39-cp39-manylinux2014_x86_64.whl |
|---|---|
| Size | 4.2 MB |
| Tags | CPython 3.9 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
eeb2b6e4899fe7de6a8597aee9304b2c63c3d1fca94fc77138a7eb11a8c746fb
|
|
BLAKE2b-256 checksum How to use checksums |
eb5c951d0de254935f575e4ecbab17cd9f3d55aab8f8230c2515cf67ed26d65c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6
|
Release files / scenario-1.2.3.dev129-cp38-cp38-manylinux2014_x86_64.whl
| Download URL | scenario-1.2.3.dev129-cp38-cp38-manylinux2014_x86_64.whl |
|---|---|
| Size | 4.2 MB |
| Tags | CPython 3.8 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
b9d8e980735e2f6100e5a2328215d4500cd08b6aa49bbf980e46455341154ae3
|
|
BLAKE2b-256 checksum How to use checksums |
06b822f759b4ca161167db4b98eb8971835dd1557b349efb78ee4837c95a9af1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6
|
