Insufficient Requirements in Documentation to Install (Specifically Gym 0.21.0)

[ashe-v00]

Hello!

I have started exploring this package and ran into a few installation requirement errors. I ended up resolving them, but thought it might be useful to share some of the things.

In your requirements.txt file, it notes that gym==0.21.0 is required. However, there is currently a known bug in installing that version (Gym Issue 3176). I ran into this same issue when trying to install conn2res using a new virtual environment (using venv and python 3.10.9).

This was resolved by ensuring setuptools==66 (pip install --upgrade setuptools==66) (Gym Issue 3200) and wheel==0.38.4 (pip install wheel==0.38.4)(Gym Issue 3202 and Gym Issue 3221) before installing the required packages as noted in the conn2res installation instructions (pip install . -r requirements.txt).

[estefanysuarez]

Hi Ashe,

Thanks for your comment. I have updated both the requirements.txt and the setup.cfg files to fix this. The right way of installing conn2res has been updated in the instructions of the README file under the Installation section. See details below.

The right way to install conn2res would be:

1. Create a virtual environment with python=3.8 (preferably using conda/anaconda)
2. activate your envirnment
3. And then:

git clone https://github.com/netneurolab/conn2res
cd conn2res
pip install .
cd ..
git clone -b v0.0.1 https://github.com/neurogym/neurogym.git
cd neurogym
pip install -e .

The requirement for neurogym==0.21.0 is now guaranteed in the setup.cfg file in the install_require section.
Notice that right now the only compatible version of NeuroGym is v0.0.1 and it has to be installed in editable mode.

[ashe-v00]

Hi @estefanysuarez ,

Thank you so much for the prompt updates! It looks like the install works smoothly now on my end.