|
| 1 | +================ |
| 2 | +OpenSlide Python |
| 3 | +================ |
| 4 | + |
| 5 | +OpenSlide Python is a Python interface to the OpenSlide library. |
| 6 | + |
| 7 | +OpenSlide_ is a C library that provides a simple interface for reading |
| 8 | +whole-slide images, also known as virtual slides, which are high-resolution |
| 9 | +images used in digital pathology. These images can occupy tens of gigabytes |
| 10 | +when uncompressed, and so cannot be easily read using standard tools or |
| 11 | +libraries, which are designed for images that can be comfortably |
| 12 | +uncompressed into RAM. Whole-slide images are typically multi-resolution; |
| 13 | +OpenSlide allows reading a small amount of image data at the resolution |
| 14 | +closest to a desired zoom level. |
| 15 | + |
| 16 | +OpenSlide can read virtual slides in several formats: |
| 17 | + |
| 18 | +* Aperio_ (``.svs``, ``.tif``) |
| 19 | +* Hamamatsu_ (``.ndpi``, ``.vms``, ``.vmu``) |
| 20 | +* Leica_ (``.scn``) |
| 21 | +* MIRAX_ (``.mrxs``) |
| 22 | +* Sakura_ (``.svslide``) |
| 23 | +* Trestle_ (``.tif``) |
| 24 | +* Ventana_ (``.bif``) |
| 25 | +* `Generic tiled TIFF`_ (``.tif``) |
| 26 | + |
| 27 | +.. _OpenSlide: http://openslide.org/ |
| 28 | +.. _Aperio: http://openslide.org/formats/aperio/ |
| 29 | +.. _Hamamatsu: http://openslide.org/formats/hamamatsu/ |
| 30 | +.. _Leica: http://openslide.org/formats/leica/ |
| 31 | +.. _MIRAX: http://openslide.org/formats/mirax/ |
| 32 | +.. _Sakura: http://openslide.org/formats/sakura/ |
| 33 | +.. _Trestle: http://openslide.org/formats/trestle/ |
| 34 | +.. _Ventana: http://openslide.org/formats/ventana/ |
| 35 | +.. _`Generic tiled TIFF`: http://openslide.org/formats/generic-tiff/ |
| 36 | + |
| 37 | +Requirements |
| 38 | +============ |
| 39 | + |
| 40 | +* Python 2 >= 2.6 or Python 3 >= 3.3 |
| 41 | +* OpenSlide >= 3.4.0 |
| 42 | +* Python Imaging Library or Pillow |
| 43 | + |
| 44 | +Installation |
| 45 | +============ |
| 46 | + |
| 47 | +1. `Install OpenSlide`_ |
| 48 | + |
| 49 | +2. ``pip install openslide-python`` |
| 50 | + |
| 51 | +.. _`Install OpenSlide`: http://openslide.org/download/ |
| 52 | + |
| 53 | +License |
| 54 | +======= |
| 55 | + |
| 56 | +LGPLv2.1_. |
| 57 | + |
| 58 | +.. _LGPLv2.1: https://raw.github.com/openslide/openslide-python/master/lgpl-2.1.txt |
0 commit comments