From c00670459f65aba58b5b465bd0ef9424157dd2aa Mon Sep 17 00:00:00 2001 From: Stefan van der Walt Date: Sun, 22 Feb 2015 23:12:24 -0800 Subject: [PATCH] Update README and installation instructions --- README.md | 81 +++++++++++++++++++++++++++++------------- doc/source/install.txt | 20 +++-------- 2 files changed, 62 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index cfc68a1e..999fa1d3 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,71 @@ -Image Processing SciKit -======================= +# scikit-image: Image processing in Python [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/scikit-image/scikit-image?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![Coverage Status](https://img.shields.io/coveralls/scikit-image/scikit-image.svg)](https://coveralls.io/r/scikit-image/scikit-image?branch=master) -Website (including documentation) ---------------------------------- -http://scikit-image.org/ +- **Website (including documentation):** [http://scikit-image.org/](http://scikit-image.org) +- **Mailing list:** [http://groups.google.com/group/scikit-image](http://groups.google.com/group/scikit-image) +- **Source:** [https://github.com/scikit-image/scikit-image](https://github.com/scikit-image/scikit-image) -Mailing List ------------- -http://groups.google.com/group/scikit-image +## Installation from binaries -Source ------- -https://github.com/scikit-image/scikit-image +- **Debian/Ubuntu:** ``sudo apt-get install python-skimage`` +- **OSX:** ``pip install scikit-image`` +- **Anaconda:** ``conda install scikit-image +- **Windows:** Download [Windows binaries](http://www.lfd.uci.edu/~gohlke/pythonlibs/#scikits.image) -Installation from source ------------------------- -Refer to DEPENDS.txt for a list of dependencies. +Also see +[http://scikit-image.org/docs/dev/install.html](http://scikit-image.org/docs/dev/install.html) -scikit-image may be installed globally using +## Installation from source - $ python setup.py install +Install [dependencies](DEPENDS.txt) using: -or locally using +``` +pip install -r requirements.txt +``` - $ python setup.py install --prefix=${HOME} +Then, install scikit-image using: -If you prefer, you can use it without installing, by simply adding -this path to your PYTHONPATH variable and compiling the extensions: +``` +$ pip install . +``` - $ python setup.py build_ext -i +If you plan to develop the package, you may run it directly from source: + +``` +$ python setup.py develop # Do this once to add pkg to Python path +$ python setup.py build_ext -i # Build binary extensions +``` + +## License + +Copyright (C) 2011, the scikit-image team +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + + 1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + 2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + 3. Neither the name of skimage nor the names of its contributors may be + used to endorse or promote products derived from this software without + specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, +INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING +IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. -License -------- -Please read LICENSE.txt in this directory. diff --git a/doc/source/install.txt b/doc/source/install.txt index 975b0b54..555ec407 100644 --- a/doc/source/install.txt +++ b/doc/source/install.txt @@ -20,13 +20,6 @@ add Neurodebian to your system package manager, then look for On systems that support setuptools, the package can be installed from the `Python packaging index `__ using - -:: - - easy_install -U scikit-image - -or - :: pip install -U scikit-image @@ -46,13 +39,9 @@ If you do not have git installed, you can also download a zipball from `https://github.com/scikit-image/scikit-image/zipball/master `_. -The SciKit can be installed globally using:: +The scikit can be installed using:: - python setup.py install - -or locally using:: - - python setup.py install --prefix=${HOME} + pip install . If you prefer, you can use it without installing, by simply adding this path to your ``PYTHONPATH`` variable and compiling extensions @@ -81,6 +70,7 @@ From the ``scikit-image`` source directory:: bentomaker build -j # (add -i for in-place build) bentomaker install # (when not builing in-place) -Depending on file permissions, the install commands may need to be run as sudo. - +Depending on file permissions, the install commands may need to be run as +sudo. + .. include:: ../../DEPENDS.txt