Support policy¶

gym-ignition is an hybrid C++ and Python project and it requires finding in the system updated compile and runtime dependencies, depending on the installation type you select.

The project mostly supports all the major operating systems. However, we are currently using and testing only GNU/Linux systems. We do not yet provide official support to other operating systems.

The table below recaps the project requirements of the Stable and Nightly channels:

Channel	C++	Python	Ignition	Ubuntu	macOS *	Windows
Stable	>= gcc8, clang6	>= 3.8	Fortress (binary)	>= 20.04	No	No
Nightly	>= gcc8, clang6	>= 3.8	Fortress (source)	>= 20.04	No	No

*: Ignition officially supports macOS and also gym-ignition could be installed on this platform. However, we do not currently test this configuration and we cannot guarantee support.

Important

Our policy is to support Ubuntu from the most recent LTS distribution, currently Ubuntu 20.04 Focal. We typically switch to a new LTS when the first minor release YY.MM.1 is released.

The Python and compilers policies follow a similar approach, we try to keep them updated as much as possible following what the supported LTS distribution includes.

Note

External contributions to extend the support and provide feedback about other platforms are most welcome.

Fun fact

In the same spirit of ubuntu/+bug/1, we have our own #1.