File tree Expand file tree Collapse file tree 2 files changed +28
-3
lines changed Expand file tree Collapse file tree 2 files changed +28
-3
lines changed Original file line number Diff line number Diff line change 1
1
Installation
2
2
============
3
3
4
- You can install pycorrelator by cloning the codes:
4
+ You can install ** pycorrelator ** by cloning the ` repository < https://github.com/technic960183/pycorrelator >`_.
5
5
6
6
.. code-block :: console
7
7
8
8
$ git clone https://github.com/technic960183/pycorrelator.git
9
9
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 **.
Original file line number Diff line number Diff line change @@ -50,7 +50,7 @@ Expected output::
50
50
5 10.690 -41.269 2400 5 3
51
51
7 10.689 -41.269 2700 5 2
52
52
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
54
54
object in the same 'cluster' will be considered as duplicates. You need to adjust this value according to the
55
55
properties of your catalog. The ``'dup_num' `` column shows the number of duplicates in each group, and the
56
56
``'rank' `` column shows the order of the object in the group sorted by the ranking column.
You can’t perform that action at this time.
0 commit comments