search

WhitakerLab / scona

Code to analyse structural covariance brain networks using python.
https://whitakerlab.github.io/scona/
MIT License
68 stars 33 forks source link

Update Development guide: Installation instructions #110

Open sgibson91 opened 5 years ago

sgibson91 commented 5 years ago

Hey! 👋

Just leaving a quick issue to say that I think the installation instructions in the development guide could have a line to say clone/fork the repo first. As it reads right now, it sounds like the pip command is the only thing a user needs to install scona.

Thanks!

Update 1

Users diving straight into the pip command may see this error message:

Could not detect requirement name for 'git+https://github.com/WhitakerLab/scona.git', please specify one with #egg=your_package_name

Perhaps the command needs to be?:

pip install -e git+https://github.com/WhitakerLab/scona.git#egg=scona

Update 2

Confirmed! pip command should be as described above in Update 1 ☝️Package installs without cloning/forking 🎉

sgibson91 commented 5 years ago

This will also need updating in the Getting Started section of the README

sgibson91 commented 5 years ago

Why I think the #egg addition is needed

The lovely developers of this package probably haven't noticed this bug in the documentation before as you've probably all got local copies of the repo which contains a setup.py file with the dependencies and builds the egg info. Without a local copy (that is to say, a git clone or fork), pip doesn't know where to get this info from and so asks you to provide it in the command line.

(At least, I think this is what's going on. I might be wrong!)

sgibson91 commented 5 years ago

Yes if I do the following, pip doesn't complain:

git clone https://github.com/WhitakerLab/scona.git
cd scona
pip install git+https://github.com/WhitakerLab/scona.git

So I think it's important to clarify whether or not users need to clone the repo first.

Islast commented 5 years ago

This is great feedback @sgibson91, this stuff was all just thrown together by me.

sgibson91 commented 5 years ago

You're welcome @Islast 🙂