Installation

You can install pycorrelator by cloning the repository.

$ git clone https://github.com/technic960183/pycorrelator.git

Note

pip install will be supported in the future after we collect enough feedback from the users. Please feel free to try this package and give us feedback. Your feedback is valuable to us.

If you encounter the error:

ModuleNotFoundError: No module named 'pycorrelator'

Please add the path of the cloned directory to sys.path by running the following code before importing the module:

import sys
path_to_pycorrelator = '/your_path_to/pycorrelator'
sys.path.append(path_to_pycorrelator)

Check if the installation is successful by importing the module:

from pycorrelator import xmatch
print(xmatch.__module__)

If the output is pycorrelator.xmatch, congratulations! You have successfully installed pycorrelator.