Switch to gymnasium in favor of openai gym

[itwasabhi]

Description

Gymnasium's gym is a drop-in replacement of open-ai's gym. Some of these gymnasium modules were already being used in this repo as it depends on PettingZoo.

Fixes #152

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

Checklist:

• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works

[micahcarroll]

@itwasabhi, sadly these changes seem to have broken some of the tests relating to PettingZoo.

[itwasabhi]

Yes -- will investigate and ping once ready!

[itwasabhi]

@micahcarroll I'm seeing very similar test failures when running tests even before these changes (i.e. 9dfc1e8, cd6739e). Any clue as to why the automated workflow flag those? I dont think the changes here are causing any new test failures (aside from the formatting ones atm)

[itwasabhi]

To clarify, its the visualization_test.py that is (and has been) problematic as far as i can tell.

The petting zoo test seems fine when it try to repro:

overcooked_ai/testing$ python overcooked_test.py TestPettingZooEnvironment -v
test_api (__main__.TestPettingZooEnvironment) ... ok

----------------------------------------------------------------------
Ran 1 test in 0.001s