search

rosalindfranklininstitute / parakeet

Phantom generator
GNU General Public License v3.0
18 stars 5 forks source link

Mention of non-python dependancies in README.md #38

Closed DimitriosBellos closed 1 year ago

DimitriosBellos commented 1 year ago

Hi James

Not important issue here, but it may cause problems to users. I have recently attempted to install parakeet in a new conda environment (in a new machine) and the pip install command were failing because I forgot to check that the non-python dependancies (e.g. FFTW) are installed. This may happen to other users too, and they will need to know to install some other software first before runing the pip install command. Can you please add a mention of them in the README.md file before the pip install python-parakeet command? Also if you are going to include the sudo apt install commands (as they are also in the documention) mention that these can only be installed this way if the user has sudo privileges. If not, they will have to either install them from source or contant their system administrator.

jmp1985 commented 1 year ago

Thanks @DimitriosBellos. I've tried to improve the README and documentation slightly to make this clearer!

DimitriosBellos commented 1 year ago

Thank you @jmp1985 . Yes it helps seeing the names of the non python requirements because when the pip install was crashing, it wan't clear in the error message that this was the reason (missing FFTW). Thank again.