Skip to content

Commit 6079255

Browse files
committed
Clarify installation instructions
With some of the packaging issues fixed the installation instructions can be simplified. In particular, `pyproject.toml` and fixed `setup.py` mean that a simple `pip install hdbscan` is now enough, assuming the user has a relatively recent `pip`. Note that the default pip on many versions of Python is pip 8, which is too old. Pip does bug to be updated, but many users do not do that. Hence there is a note that if there is an issue to first upgrade pip then try again. Another feature of pip is that it can pull directly from GitHub. This can be useful if a new feature is merged but not yet pushed to PyPI. The one-liner pip install is more convenient than manual download and installation.
1 parent 496f010 commit 6079255

File tree

1 file changed

+20
-19
lines changed

1 file changed

+20
-19
lines changed

README.rst

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ Easiest install, if you have Anaconda (thanks to conda-forge which is awesome!):
173173
174174
conda install -c conda-forge hdbscan
175175
176-
PyPI install, presuming you have sklearn and all its requirements (numpy and scipy) installed:
176+
PyPI install, presuming you have an up to date pip:
177177

178178
.. code:: bash
179179
@@ -182,41 +182,42 @@ PyPI install, presuming you have sklearn and all its requirements (numpy and sci
182182
Binary wheels for a number of platforms are available thanks to the work of
183183
Ryan Helinski <[email protected]>.
184184

185-
If pip is having difficulties pulling the dependencies then we'd suggest installing
186-
the dependencies manually using anaconda followed by pulling hdbscan from pip:
185+
If pip is having difficulties pulling the dependencies then we'd suggest to first upgrade
186+
pip to at least version 10 and try again:
187187

188188
.. code:: bash
189189
190-
conda install cython
191-
conda install numpy scipy
192-
conda install scikit-learn
190+
pip install --upgrade pip
193191
pip install hdbscan
194192
195-
For a manual install get this package:
193+
Otherwise install the dependencies manually using anaconda followed by pulling hdbscan from pip:
196194

197195
.. code:: bash
198196
199-
wget https://github.com/scikit-learn-contrib/hdbscan/archive/master.zip
200-
unzip master.zip
201-
rm master.zip
202-
cd hdbscan-master
203-
204-
Install the requirements
197+
conda install cython
198+
conda install numpy scipy
199+
conda install scikit-learn
200+
pip install hdbscan
205201
206-
.. code:: bash
207202
208-
sudo pip install -r requirements.txt
209-
210-
or
203+
For a manual install of the latest code directly from GitHub:
211204

212205
.. code:: bash
213206
214-
conda install scikit-learn cython
207+
pip install --upgrade git+https://github.com/scikit-learn-contrib/hdbscan.git#egg=hdbscan
215208
216-
Install the package
209+
210+
Alternatively download the package, install requirements, and manually run the installer:
217211

218212
.. code:: bash
219213
214+
wget https://github.com/scikit-learn-contrib/hdbscan/archive/master.zip
215+
unzip master.zip
216+
rm master.zip
217+
cd hdbscan-master
218+
219+
pip install -r requirements.txt
220+
220221
python setup.py install
221222
222223
-----------------

0 commit comments

Comments
 (0)