.. include:: common_links.inc
.. _iris_docs:


Iris
====

**A powerful, format-agnostic, community-driven Python package for analysing
and visualising Earth science data.**

Iris implements a data model based on the `CF conventions <https://cfconventions.org>`_
giving you a powerful, format-agnostic interface for working with your data.
It excels when working with multi-dimensional Earth Science data, where tabular
representations become unwieldy and inefficient.

For more information see :ref:`why_iris`.


.. grid:: 1 1 2 2
    :gutter: 2

    .. grid-item-card:: Getting Started
        :class-title: custom-title
        :class-body: custom-body
        :link: getting_started_index
        :link-type: ref
        :img-top: _static/icon_shuttle.svg
        :class-img-top: dark-light
        :class-card: sd-rounded-3

        Installing and gallery examples.

    .. grid-item-card:: User Manual
        :class-title: custom-title
        :class-body: custom-body
        :link: user_manual_index
        :link-type: ref
        :img-top: _static/icon_instructions.svg
        :class-img-top: dark-light
        :class-card: sd-rounded-3

        Learn how to use Iris.

    .. grid-item-card:: Developers Guide
        :class-title: custom-title
        :class-body: custom-body
        :link: development_where_to_start
        :link-type: ref
        :img-top: _static/icon_development.svg
        :class-img-top: dark-light
        :class-card: sd-rounded-3

        Contribute to Iris as a developer.

    .. grid-item-card:: Iris API
        :class-title: custom-title
        :class-body: custom-body
        :link: generated/api/iris.html
        :img-top: _static/icon_api.svg
        :class-img-top: dark-light
        :class-card: sd-rounded-3

        Iris functionality by module.

    .. grid-item-card:: What's New
        :class-title: custom-title
        :class-body: custom-body
        :link: iris_whatsnew
        :link-type: ref
        :img-top: _static/icon_new_product.svg
        :class-img-top: dark-light
        :class-card: sd-rounded-3

        Recent changes in Iris.

    .. grid-item-card:: Voted Issues
        :class-title: custom-title
        :class-body: custom-body
        :link: voted_issues_top
        :link-type: ref
        :img-top: _static/icon_thumb.png
        :class-img-top: dark-light
        :class-card: sd-rounded-3

        Raise the profile of issues by voting.


Icons made by FreePik from `Flaticon <https://www.flaticon.com/>`_


.. include:: gallery_carousel.txt


.. _iris_support:

Support
~~~~~~~

We, the Iris developers have adopted `GitHub Discussions`_ to capture any
discussions or support questions related to Iris.

See also `StackOverflow for "How Do I? <https://stackoverflow.com/questions/tagged/python-iris>`_
that may be useful but we do not actively monitor this.

The legacy support resources:

* `Users Google Group <https://groups.google.com/forum/#!forum/scitools-iris>`_
* `Developers Google Group <https://groups.google.com/forum/#!forum/scitools-iris-dev>`_
* `Legacy Documentation`_ (Iris 2.4 or earlier).  This is an archive of zip
  files of past documentation.  You can download, unzip and view the
  documentation locally (index.html).  There may be some incorrect rendering
  and older javascvript (.js) files may show a warning when uncompressing, in
  which case we suggest you use a different unzip tool.


.. toctree::
   :caption: User Manual
   :maxdepth: 1
   :name: user_manual
   :hidden:

   user_manual/index


.. toctree::
   :caption: Developers Guide
   :maxdepth: 1
   :name: developers_index
   :hidden:

   developers_guide/contributing_getting_involved


.. toctree::
   :caption: What's New in Iris
   :maxdepth: 1
   :name: whats_new_index
   :hidden:

   whatsnew/index


.. todolist::