Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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.

Metadata

Release files for scenar-io 1.2.3.dev70

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for scenar-io 1.2.3.dev70
File Size Uploaded Provenance Actions
scenar_io-1.2.3.dev70.tar.gz 137.8 kB Without provenance Details for scenar_io-1.2.3.dev70.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for scenar-io 1.2.3.dev70
File Interpreter ABI Platform Actions
scenar_io-1.2.3.dev70-cp39-cp39-manylinux2014_x86_64.whl CPython 3.9 CPython 3.9 Linux glibc 2.17+ x86-64 Details for scenar_io-1.2.3.dev70-cp39-cp39-manylinux2014_x86_64.whl
scenar_io-1.2.3.dev70-cp38-cp38-manylinux2014_x86_64.whl CPython 3.8 CPython 3.8 Linux glibc 2.17+ x86-64 Details for scenar_io-1.2.3.dev70-cp38-cp38-manylinux2014_x86_64.whl

Total release size: 8.7 MB

Release files / scenar_io-1.2.3.dev70.tar.gz

Download URL scenar_io-1.2.3.dev70.tar.gz
Size 137.8 kB
Tags Source
SHA-256 checksum
How to use checksums
8a19bd5109343cc08cbd53daa7b88ac8b30d1029c6898e5f66d5005de6bca0da
BLAKE2b-256 checksum
How to use checksums
deb56b1312cd475355645130370eb2e67fed0a22b247f8b3b3fd1adf2968d4bc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.6

Release files / scenar_io-1.2.3.dev70-cp39-cp39-manylinux2014_x86_64.whl

Download URL scenar_io-1.2.3.dev70-cp39-cp39-manylinux2014_x86_64.whl
Size 4.3 MB
Tags CPython 3.9 Linux glibc 2.17+ x86-64
SHA-256 checksum
How to use checksums
a0d57d4b519adefafcec3fb6f90680a9797948284ec151d43b3267cec5db68be
BLAKE2b-256 checksum
How to use checksums
c539f9b5f1f46c5ee1f310f2cb52528dbf4f7c01d15a1ac4980eeeaeea797a39
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.6

Release files / scenar_io-1.2.3.dev70-cp38-cp38-manylinux2014_x86_64.whl

Download URL scenar_io-1.2.3.dev70-cp38-cp38-manylinux2014_x86_64.whl
Size 4.3 MB
Tags CPython 3.8 Linux glibc 2.17+ x86-64
SHA-256 checksum
How to use checksums
4cb169314150f844f259b5d155d412c807d7091617d7c93557597b7ccd0b2bc6
BLAKE2b-256 checksum
How to use checksums
88a57088d236b9f53d91e2d67d0640d057359ca5646d24c9194b854c367e0942
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.6

Security for scenar-io 1.2.3.dev70

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page