OpenViSTAI · Agents · Blockchain · Crypto
Submit a project
Menu
AI Developer Tools & SDKs

Shimmy — Farama-Foundation

Shimmy is a Python library that provides API-conversion bindings between selected external reinforcement-learning environments and Gymnasium or PettingZoo.

Explore the practical guide ↓

Independent OpenViST project profile, based on linked sources.

Shimmy — Farama-Foundation — OpenViST project profile in AI Developer Tools & SDKs.
OpenViST project illustration. See the linked sources for product details.
Understand the project

Practical overview

When it fits

Use Shimmy when a supported external environment suite needs a Gymnasium or PettingZoo binding, and select the matching optional dependency and Python version for that suite.

Who it is for

  • Python developers integrating supported external environments into Gymnasium workflows.
  • Developers connecting DM Control Soccer or OpenSpiel environments to PettingZoo.

Documented uses

  • Convert OpenAI Gym environments for use through Gymnasium.
  • Use DeepMind Control environments with Gymnasium.
  • Connect DM Control Soccer and OpenSpiel environments to PettingZoo.
Before you choose

Requirements & limits

The project is an open-source Python library under the MIT license. Its README documents installation from PyPI with pip.

  • The source environment suite determines whether the target binding is Gymnasium or PettingZoo.
  • Optional dependency groups have different Python version ceilings; OpenSpiel supports through 3.14, while the other listed extras have lower ceilings.
  • The README example shows a DM Control environment created with Gymnasium and its observation and action spaces inspected.

Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.

Source-based practical guide

Install Shimmy and an environment extra

Install the library and select the documented optional dependencies for an environment suite.

Before you start

  • Python 3.11 or newer.
  • Choose one of the documented extras: gym-v21, gym-v26, dm-control, dm-control-multi-agent or openspiel.

Steps

  1. Install the library with the command below.

    Documented command
    pip install shimmy

  2. Install an environment extra, for example the command below.

    Documented command
    pip install shimmy[dm-control]

Expected outcome

Shimmy and the selected environment dependencies are installed for use with their supported bindings.

Guide limitations

  • Python version ceilings vary by extra: gym-v21 through 3.11; gym-v26, dm-control and dm-control-multi-agent through 3.12; openspiel through 3.14.
Documentation 1 ↗
Source-based practical guide

Create a DM Control environment through Gymnasium

Use Shimmy’s registered DM Control environments with Gymnasium and inspect their spaces.

Before you start

  • Python 3.11 or newer and the dm-control extra.
  • Gymnasium and Shimmy.

Steps

  1. Import Gymnasium and DM_CONTROL_SUITE_ENVS from shimmy.registration.

  2. Build environment IDs from the registered suite entries using the dm_control/…-v0 format.

  3. Create an environment with gym.make using one of those IDs.

  4. Inspect its observation and action spaces; the README also demonstrates applying gym.wrappers.FlattenObservation.

Expected outcome

A DM Control environment is represented as a Gymnasium environment, with its spaces available for inspection.

Guide limitations

  • The documented DM Control extras support Python through 3.12.
  • The example demonstrates environment creation and space inspection, not a training procedure.
Documentation 1 ↗
Evidence and transparency

Sources & review

Official repository ↗
Source record details
Source availability
Active
Sources checked
13 October 2026
Original website title
Farama-Foundation/Shimmy · Official homepage title · retained in its source language
How we review sourcesSuggest a correction