Skip to content

Commit 8af5374

Browse files
committed
Finish writing the installation instructions.
Add the details about how to resolve the error when the module is not found.
1 parent 7fb373e commit 8af5374

File tree

2 files changed

+28
-3
lines changed

2 files changed

+28
-3
lines changed

docs/source/install.rst

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,35 @@
11
Installation
22
============
33

4-
You can install pycorrelator by cloning the codes:
4+
You can install **pycorrelator** by cloning the `repository <https://github.com/technic960183/pycorrelator>`_.
55

66
.. code-block:: console
77
88
$ git clone https://github.com/technic960183/pycorrelator.git
99
10-
pip install will be supported in the future.
10+
.. note::
11+
``pip install`` will be supported in the future after we collect enough feedback from the users.
12+
Please feel free to try this package and give us feedback. Your feedback is valuable to us.
13+
14+
If you encounter the error:
15+
16+
.. code-block:: console
17+
18+
ModuleNotFoundError: No module named 'pycorrelator'
19+
20+
Please add the path of the cloned directory to ``sys.path`` by running the following code before importing the module:
21+
22+
.. code-block:: python
23+
24+
import sys
25+
path_to_pycorrelator = '/your_path_to/pycorrelator'
26+
sys.path.append(path_to_pycorrelator)
27+
28+
Check if the installation is successful by importing the module:
29+
30+
.. code-block:: python
31+
32+
from pycorrelator import xmatch
33+
print(xmatch.__module__)
34+
35+
If the output is ``pycorrelator.xmatch``, congratulations! You have successfully installed **pycorrelator**.

docs/source/tutorial/duplicates_removal.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Expected output::
5050
5 10.690 -41.269 2400 5 3
5151
7 10.689 -41.269 2700 5 2
5252

53-
Here I set the tolerance to 0.01, which means that objects with a separation less than 0.01 degrees to any other
53+
Here we set the tolerance to 0.01, which means that objects with a separation less than 0.01 degrees to any other
5454
object in the same 'cluster' will be considered as duplicates. You need to adjust this value according to the
5555
properties of your catalog. The ``'dup_num'`` column shows the number of duplicates in each group, and the
5656
``'rank'`` column shows the order of the object in the group sorted by the ranking column.

0 commit comments

Comments
 (0)