Skip to content

Commit a7a95e2

Browse files
committedNov 17, 2021
Update install instructions in the docs
1 parent 5d73ae8 commit a7a95e2

File tree

1 file changed

+3
-10
lines changed

1 file changed

+3
-10
lines changed
 

‎docs/install.rst

+3-10
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,9 @@ FilFinder can be installed via pip:
55

66
>>> pip install fil_finder # doctest: +SKIP
77

8-
To install from the repository, run:
8+
To install from the repository, run the following from within the repository folder:
99

10-
>>> python setup.py install # doctest: +SKIP
11-
12-
13-
**NOTE:** Due to install conflicts amongst FilFinder's dependencies, installing the package will **NOT** install the dependencies. To check if you have the necessary packages installed, run:
14-
15-
>>> python setup.py check_deps # doctest: +SKIP
16-
17-
Unfortunately, this is only available when installing from the repository.
10+
>>> pip install -e . # doctest: +SKIP
1811

1912
Quickest way to get FilFinder working
2013
-------------------------------------
@@ -27,7 +20,7 @@ Install the dependencies using:
2720
>>> conda install --yes numpy scipy matplotlib astropy scikit-image networkx # doctest: +SKIP
2821

2922
This will install all of the newest releases of those packages. FilFinder can then be installed as explained
30-
above. Test with the ``check_deps`` option if in doubt.
23+
above.
3124

3225
Package Dependencies
3326
--------------------

0 commit comments

Comments
 (0)
Please sign in to comment.