search

terrier-org / pyterrier

A Python framework for performing information retrieval experiments, building on http://terrier.org/
https://pyterrier.readthedocs.io/
Mozilla Public License 2.0
397 stars 63 forks source link

Add troubleshoot for installation and certification error #411

Closed Krissy510 closed 8 months ago

Krissy510 commented 8 months ago

I tried to install PyTerrier on macOS (M1) and Ubuntu 22.04 (Docker). However, both installations failed because pyautocorpus could not find pcre. After installing pcre I can install PyTerrier successfully.

After finished installing, for macOS there's an error that will cause due to a certification error. To solve this issue the user will need to install a certificate which is located in the Python folder.

These solutions and errors were not presented in the current documentation which is why I suggest adding a troubleshooting guide in case any users have the same issue.

cmacdonald commented 8 months ago

Thanks @Krissy510 - do you have a copy of the exceptions you saw.

https://github.com/seanmacavaney/pyautocorpus/issues/3 seems related @seanmacavaney

Krissy510 commented 8 months ago

Thanks @Krissy510 - do you have a copy of the exceptions you saw.

seanmacavaney/pyautocorpus#3 seems related @seanmacavaney

Yes, I do. This example is what I got from trying to install PyTerrier on Ubuntu 22.04. This also happened on macOS. error message

cmacdonald commented 8 months ago

Yes, we dont have MacM1 builds for pyautocorpus (blame github :-( ) For ubuntu, I would have expected the build binaries to have worked, as there is a Python 3.10 manylinux build - see https://pypi.org/project/pyautocorpus/0.1.12/#files

Krissy510 commented 8 months ago

Yes, we dont have MacM1 builds for pyautocorpus (blame github :-( ) For ubuntu, I would have expected the build binaries to have worked, as there is a Python 3.10 manylinux build - see https://pypi.org/project/pyautocorpus/0.1.12/#files

I understood that, but the point of this pull request is to add a section to give a guide to troubleshooting issues that are presented. After installing pcre I was able to install it successfully. In addition, for the certification error, I think it is a good idea to write this down in the installation guide for macOS users.

cmacdonald commented 8 months ago

Yes, I understood that, and we appreciate the PR. We may merge, but at least for the pyautocorpus there may be an underlying problem.

cmacdonald commented 8 months ago

@seanmacavaney pointed out that your arch is M1 even for Ubuntu, hence explaining why pyautocorpus needs compiled. We may drop pyautocorpus as a required dependency in ir_datasets, but thats for the future.

cmacdonald commented 8 months ago

Merged, thanks @Krissy510 !