Files
scikit-image/DEPENDS.txt
T
Steven Silvester 09876408fc Fix some sphinx warnings and add to build
Fix some sphinx warnings

Add documentation build to test

Add documentation build to test

Remove change in numpydoc

Remove change in apigen

Add makefile target for html and add to travis script

Add a makefile target for html and add to travis script

Fix more sphinx warnings
2015-02-07 16:40:26 -06:00

62 lines
2.2 KiB
Plaintext

Build Requirements
------------------
* `Python >= 2.6 <http://python.org>`__
* `Numpy >= 1.6 <http://numpy.scipy.org/>`__
* `Cython >= 0.21 <http://www.cython.org/>`__
* `Six >=1.3 <https://pypi.python.org/pypi/six>`__
You can use pip to automatically install the base dependencies as follows::
$ pip install -r requirements.txt
Runtime requirements
--------------------
* `SciPy <http://scipy.org>`__
* `Matplotlib <http://matplotlib.sf.net>`__
* `NetworkX <https://networkx.github.io>`__
* `Pillow <https://pypi.python.org/pypi/Pillow>`__
(or `PIL <http://www.pythonware.com/products/pil/>`__)
Known build errors
------------------
On Windows, the error ``Error:unable to find vcvarsall.bat`` means that
distutils is not correctly configured to use the C compiler. Modify (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
Optional Requirements
---------------------
You can use this scikit with the basic requirements listed above, but some
functionality is only available with the following installed:
* `PyQt4 <http://wiki.python.org/moin/PyQt>`__
The ``qt`` plugin that provides ``imshow(x, fancy=True)`` and `skivi`.
* `FreeImage <http://freeimage.sf.net>`__
The ``freeimage`` plugin provides support for reading various types of
image file formats, including multi-page TIFFs.
* `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 io capability.
* `SimpleITK <http://www.simpleitk.org/>`
Optional io 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 io plugin providing most standard `formats <http://pythonhosted.org//imread/formats.html>`__.
Testing requirements
--------------------
* `Nose <https://nose.readthedocs.org/en/latest/>`__
A Python Unit Testing Framework
* `Coverage.py <http://nedbatchelder.com/code/coverage/>`__
A tool that generates a unit test code coverage report