Gym-MiniGrid/docs/content/installation.md

Installation

To install minigrid, the easiest way is to use pip:

pip install minigrid

However, if you would like to build on top of minigrid, you would need to install it from source. To do this, first clone the repository:

git clone https://github.com/Farama-Foundation/Minigrid.git

Then, install the package:

cd Minigrid
python3 -m pip install .

If you want to install the package in development mode, use the following command instead:

python3 -m pip install -e .

An installation in development mode (i.e., an editable install) is useful if you want to modify the source code of minigrid and have your changes take effect immediately.