robotology-legacy / gym-ignition

Framework for developing OpenAI Gym robotics environments simulated with Ignition Gazebo
https://robotology.github.io/gym-ignition
GNU Lesser General Public License v3.0
231 stars 26 forks source link

Check for a compatible Ignition distribution in the system when importing the `scenario` Python package #399

Closed diegoferigo closed 3 years ago

diegoferigo commented 3 years ago

Often happens that users don't read thoroughly the support policy and install the wrong Ignition distribution. When this happens, importing scenario fails with arcane error on shared libraries not found.

This PR implements a new feature that should provide a more explanatory error message to the users in this case. It covers both cases in which the ign command does not exists in PATH (i.e. either Ignition is not installed or the environment is not properly configured) and if ign gazebo --versions returns a failing exit code (to be future proof in case the command line changes in next versions).

From the python side, we exploit the packaging package.