forked from scikit-image/scikit-image
-
Notifications
You must be signed in to change notification settings - Fork 1
/
INSTALL.rst
148 lines (103 loc) · 4.76 KB
/
INSTALL.rst
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
Installing scikit-image
=======================
We are assuming that you have default Python environment already configured on
your computer and you intend to install ``scikit-image`` inside of it. If you
want to create and work with Python virtual environments, please follow the
instructions on `venv`_ and `virtual environments`_.
There are two ways you can install ``scikit-image`` on your preferred Python
environment.
1. Standard Installation
2. Development Installation
1. Standard Installation:
-------------------------
``scikit-image`` comes pre-installed with several Python distributions,
including `Anaconda <https://www.anaconda.com/download/>`_,
`Enthought Canopy <https://www.enthought.com/product/canopy/>`_,
`Python(x,y) <https://python-xy.github.io/>`_ and
`WinPython <https://winpython.github.io/>`_.
On all other systems, install it via shell/command prompt::
pip install scikit-image
If you are running Anaconda or miniconda, use::
conda install -c conda-forge scikit-image
2. Development Installation:
----------------------------
You can install the ``scikit-image`` development version if either your
distribution ships an outdated version or you want to develop and work on new
features before the package is released officially.
First, uninstall any existing installations::
pip uninstall scikit-image
or, on conda-based systems::
conda uninstall scikit-image
Now, clone scikit-image on your local computer, and install::
git clone https://github.com/scikit-image/scikit-image.git
cd scikit-image
pip install -e .
To update the installation::
git pull # Grab latest source
pip install -e . # Reinstall
Platform-specific notes follow below.
a. Windows
``````````
If you experience the error ``Error:unable to find vcvarsall.bat`` it means
that your computer does not have recommended compilers for Python. You can
either download and install Windows compilers from `here`_ or use
`MinGW compilers`_ . If using `MinGW`, make sure to correctly configure
``distutils`` by modifying (or create, if not existing) the configuration file
``distutils.cfg`` (located for example at
``C:\Python26\Lib\distutils\distutils.cfg``) to contain::
[build]
compiler=mingw32
A run-through of the compilation process for Windows is included in
our `setup of AppVeyor`_ (a continuous integration service).
.. _miniconda: http://conda.pydata.org/miniconda.html
.. _python.org: http://python.org/
.. _Christoph Gohlke's: http://www.lfd.uci.edu/~gohlke/pythonlibs/
.. _setup of AppVeyor: https://github.com/scikit-image/scikit-image/blob/master/.appveyor.yml
.. _here: https://wiki.python.org/moin/WindowsCompilers#Microsoft_Visual_C.2B-.2B-_14.0_standalone:_Visual_C.2B-.2B-_Build_Tools_2015_.28x86.2C_x64.2C_ARM.29
.. _venv: https://docs.python.org/3/library/venv.html
.. _virtual environments: http://docs.python-guide.org/en/latest/dev/virtualenvs/
.. _MinGW compilers: http://www.mingw.org/wiki/howto_install_the_mingw_gcc_compiler_suite
b. Debian and Ubuntu
````````````````````
Install all the required dependencies::
sudo apt-get install python-matplotlib python-numpy python-pil python-scipy
Install suitable compilers::
sudo apt-get install build-essential cython
Complete the general development installation instructions above.
Build Requirements
------------------
* `Python >= 3.5 <http://python.org>`__
* `Numpy >= 1.11 <http://numpy.scipy.org/>`__
* `Cython >= 0.23.4 <http://www.cython.org/>`__
Build Requirements (docs)
-------------------------
.. include:: ../../requirements/docs.txt
:literal:
Runtime requirements
--------------------
.. include:: ../../requirements/default.txt
:literal:
Optional Requirements
---------------------
You can use ``scikit-image`` with the basic requirements listed above, but some
functionality is only available with the following installed:
* `PyQt5 <http://wiki.python.org/moin/PyQt>`__ or `PySide2 <https://wiki.qt.io/Qt_for_Python>`__ through `qtpy <https://github.com/spyder-ide/qtpy>`__
A ``Qt`` plugin will provide ``imshow(x, fancy=True)`` and `skivi`.
* `PyAMG <http://pyamg.org/>`__
The ``pyamg`` module is used for the fast `cg_mg` mode of random
walker segmentation.
* `Astropy <http://www.astropy.org>`__
Provides FITS I/O capability.
* `SimpleITK <http://www.simpleitk.org/>`__
Optional I/O plugin providing a wide variety of `formats <http://www.itk.org/Wiki/ITK_File_Formats>`__.
including specialized formats using in medical imaging.
* `imread <http://pythonhosted.org/imread/>`__
Optional I/O plugin providing most standard `formats <http://pythonhosted.org//imread/formats.html>`__.
Testing requirements
--------------------
.. include:: ../../requirements/test.txt
:literal:
Documentation requirements
--------------------------
.. include:: ../../requirements/docs.txt
:literal: