Back to Scikit Image

scikit-image's documentation

doc/source/index.rst

0.26.02.6 KB
Original Source

scikit-image's documentation

Date: |today|, Version: |version|

Welcome! scikit-image_ is an image processing toolbox which builds on numpy, scipy.ndimage and other libraries to provide a versatile set of image processing routines in Python_. Our project and community is guided by the :doc:about/code_of_conduct.

.. _scikit-image: https://scikit-image.org .. _numpy: https://numpy.org .. _scipy.ndimage: https://docs.scipy.org/doc/scipy/reference/ndimage.html .. _Python: https://www.python.org

.. grid:: 2 :gutter: 3

.. grid-item-card:: :octicon:`rocket` Get started
    :link: user_guide/install
    :link-type: any

    New to scikit-image? Start with our installation guide and scikit-image's key
    concepts.

.. grid-item-card:: :octicon:`image` Examples
    :link: auto_examples/index
    :link-type: any

    Browse our gallery of entry-level and domain-specific examples.

.. grid-item-card:: :octicon:`comment-discussion` Get help :octicon:`link-external`
    :link: https://forum.image.sc/tag/scikit-image

    Need help with a particular image analysis task? Ask us and a large
    image analysis community on our user forum *image.sc*.

.. grid-item-card:: :octicon:`repo` API reference
    :link: api/api
    :link-type: any

    A detailed description of scikit-image's public Python API. Assumes an
    understanding of the key concepts.

.. grid-item-card:: :octicon:`tools` Contribute
    :link: development/contribute
    :link-type: any

    Saw a typo? Found a bug? Want to improve a function? Learn how to
    contribute to scikit-image!

.. grid-item-card:: :octicon:`history` Release notes
    :link: release_notes/index
    :link-type: any

    Upgrading from a previous version? See what's new and changed between
    each release of scikit-image.

.. grid-item-card:: :octicon:`people` About us
    :link: about/index
    :link-type: any

    Get to know the project and the community. Learn where we are going and
    how we work together.

.. grid-item-card:: :octicon:`milestone` SKIPs
    :link: skips/index
    :link-type: any

    scikit-image proposals, documents describing major changes to the
    library.

See also our site-wide :ref:genindex our :ref:search this documentation <search>.

.. toctree:: :hidden:

user_guide/index
auto_examples/index
api/api
release_notes/index
development/index
about/index