Skip to content

Commit 6d8175b

Browse files
committed
Updated to meta docs.
1 parent f7ca4ba commit 6d8175b

File tree

3 files changed

+20
-32
lines changed

3 files changed

+20
-32
lines changed

CHANGELOG

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
1.2.0
2+
- Python 3 support
23
- Split up one big file into smaller more logical sub-modules
34

45
1.1.1b3

INSTALL

Lines changed: 12 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,27 @@
11
INSTALLATION
22
============
33

4-
Linux
5-
-----
4+
Simply run::
65

7-
RPM-Installation
8-
~~~~~~~~~~~~~~~~
6+
pip install cluster
97

10-
I'm not familiar with RPM-distributions but as far as I know it should be
11-
something like::
8+
Or, if you run it in a virtualenv:
129

13-
rpm -i <filename.rpm>
10+
/path/to/your/env/bin/pip install cluster
1411

15-
RPM-source Installation
16-
~~~~~~~~~~~~~~~~~~~~~~~
1712

18-
This is something I don't know. If somebody can enlighten me, please do!
13+
Source installation
14+
~~~~~~~~~~~~~~~~~~~
1915

20-
Binary/Source installation
21-
~~~~~~~~~~~~~~~~~~~~~~~~~~
16+
Untar the archive::
2217

23-
Untar the package with you favourite archive tool. On the console it will be
24-
something along the lines::
25-
26-
tar xzf <filename.tar.gz>
18+
tar xf <filename.tar.gz>
2719

2820
Next, go to the folder just created. It will have the same name as the package
29-
(for example "cluster-1.0.0b1") and run::
30-
31-
python setup.py install
32-
33-
For this step you need root-priviledges
34-
35-
Windows
36-
-------
21+
(for example "cluster-1.2.0") and run::
3722

38-
Execute the executable file and follow the instructions displayed. Default
39-
values will be fine in most cases.
23+
python setup.py install
4024

41-
MacOS-X
42-
-------
25+
This will require superuser privileges unless you install it in a virtual environment::
4326

44-
Simply follow the same instructions as with the Linux-Source installation.
27+
/path/to/your/env/bin/python setup.py install

README

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,17 @@ between two of those objects. For simple datatypes, like integers, this can be
99
as simple as a subtraction, but more complex calculations are possible. Right
1010
now, it is possible to generate the clusters using a hierarchical clustering
1111
and the popular K-Means algorithm. For the hierarchical algorithm there are
12-
different "linkage" (single, complete, average and uclus) methods available. I
13-
plan to implement other algoithms as well on an
14-
"as-needed" or "as-I-have-time" basis.
12+
different "linkage" (single, complete, average and uclus) methods available.
1513

1614
Algorithms are based on the document found at
1715
http://www.elet.polimi.it/upload/matteucc/Clustering/tutorial_html/
1816

17+
.. note::
18+
The above site is no longer avaialble, but you can still view it in the
19+
internet archive at:
20+
https://web.archive.org/web/20070912040206/http://home.dei.polimi.it//matteucc/Clustering/tutorial_html/
21+
22+
1923
USAGE
2024
=====
2125

0 commit comments

Comments
 (0)