:notoc:

.. module:: phenotypic

PhenoTypic
==========

.. container:: subtitle

   A modular framework for bioimage analysis and visualization


Welcome to Phenotypic's documentation. Here you'll find comprehensive guides and examples to help you get the most out of Phenotypic.



.. grid:: 1 2 3 3
   :gutter: 4
   :padding: 2 2 0 0
   :class-container: sd-text-center

   .. grid-item-card::  User guide
      :img-top: ./_static/assets/200x150/user_guide_book.svg
      :class-card: intro-card
      :shadow: md

      The user guide explains how to get started as well as an in-depth overview of the
      key concepts of Phenotypic with useful background information and explanation.

      +++

      .. button-ref:: user_guide/index
         :ref-type: doc
         :click-parent:
         :color: secondary
         :expand:

         To the user guide


   .. grid-item-card:: Examples
      :img-top: ./_static/assets/200x150/examples.svg
      :class-card: intro-card
      :shadow: md

      The Examples provide a hands-on introduction to *Phenotypic*.

      +++

      .. button-ref:: user_guide/examples/index
         :ref-type: doc
         :click-parent:
         :color: secondary
         :expand:

         To the examples

   .. grid-item-card::  Downloads
      :img-top: ./_static/assets/200x150/downloads.svg
      :class-card: intro-card
      :shadow: md

      Downloadable helper scripts for deploying PhenoTypic at scale.

      +++

      .. button-ref:: downloads
         :ref-type: doc
         :click-parent:
         :color: secondary
         :expand:

         To downloads!

   .. grid-item-card::  API reference
      :img-top: ./_static/assets/200x150/api_ref_sign.svg
      :class-card: intro-card
      :shadow: md

      The reference guide contains the detailed description of
      the Phenotypic API. The reference describes in detail how the methods work and which parameters can
      be used. It assumes that you have an understanding of the key concepts.

      +++

      .. button-ref:: api_reference/index
         :ref-type: doc
         :click-parent:
         :color: secondary
         :expand:

         To the API reference

   .. grid-item-card::  Contributor guide
      :img-top: ./_static/assets/200x150/dev_guide.svg
      :class-card: intro-card
      :shadow: md

      Phenotypic's strength is in its ability to integrate new modules and workflows. 
      Learn how to make your own module and contribute to the codebase here!

      +++

      .. button-ref:: contrib_guide/index
         :ref-type: doc
         :click-parent:
         :color: secondary
         :expand:

         To the contributor guide\


   .. grid-item-card::  Report a problem
      :img-top: ./_static/assets/200x150/contact_us.svg
      :class-card: intro-card
      :shadow: md
      :link: https://github.com/exfab/PhenoTypic/issues
      :link-type: url

      Notice a problem or need help? Open an issue on GitHub and add a label so we can help you faster.

      +++


.. toctree::
   :maxdepth: 3
   :caption: Documentation
   :hidden:
   :titlesonly:

   user_guide/index
   api_reference/index
   contrib_guide/index
   downloads