Skip to content
Browse files

DOC: update installation instructions

  • Loading branch information...
1 parent b6f082c commit e353d489b32ea294c20b9b3a1e598b30a019c6ca @GaelVaroquaux GaelVaroquaux committed Jan 11, 2012
Showing with 29 additions and 5 deletions.
  1. +29 −5 doc/installing.rst
View
34 doc/installing.rst
@@ -4,25 +4,40 @@ Installing joblib
The `easy_install` way
-----------------------
-The easiest way to install joblib is (provided that you have `setuptools`
-installed) to run::
+For the easiest way to install joblib you need to have `setuptools`
+installed.
+
+* For installing for all users, you need to run::
easy_install joblib
-You may need to run the above command as administrator
+ You may need to run the above command as administrator
-On a unix environment, it is better to install outside of the hierarchy
-managed by the system:
+ On a unix environment, it is better to install outside of the hierarchy
+ managed by the system::
easy_install --prefix /usr/local joblib
+* Installing only for a specific user is easy if you use Python 2.6 or
+ above::
+
+ easy_install --user joblib
+
.. warning::
Packages installed via `easy_install` override the Python module look
up mechanism and thus can confused people not familiar with
setuptools. Although it may seem harder, we suggest that you use the
manual way, as described in the following paragraph.
+Using distributions
+--------------------
+
+Joblib is packaged for several linux distribution: archlinux, debian,
+ubuntu, and altlinux. For minimum administration overhead, using the
+package manager is the recommended installation strategy on these
+systems.
+
The manual way
---------------
@@ -37,6 +52,15 @@ create a local environment and install `joblib` in it. One of the pros of
this method is that you never have to become administrator, and thus all
the changes are local to your account and easy to clean up.
+* **If you are under Pyton 2.6 or above**
+
+ Simple go in the directory created by expanding the `joblib` tarball
+ and run the following command::
+
+ python setup.py install --user
+
+* **If you are under Python 2.5**
+
#. First, create the following directory (where `~` is your home
directory, or any directory that you want to use as a base for
your local Python environment, and `X` is your Python version

0 comments on commit e353d48

Please sign in to comment.
Something went wrong with that request. Please try again.