.. _intake-esm:

Working with Intake and Intake-ESM
==================================

`Intake <https://intake.readthedocs.io/en/latest/>`__ is a library that allows you to easily access data from a variety of sources in a tree-like catalog structure. 

Its sub-variant ,`Intake-ESM <https://intake-esm.readthedocs.io/en/latest/>`__ assumes a table/database style structure with grouping by pre-specified columns. It is mainly used in the context of `CMIP <https://cmip-data-pool.dkrz.de/>`__, where data is strongly standardized, and thus many models can be compared easily, and intake scripts can iterate across models and ensemble members.

Tutorials for Intake
--------------------
.. toctree::
   :maxdepth: 1
   :glob:

   show_catalog
   query_yaml
   search_yaml
   
   
Tutorials for Intake-ESM
------------------------

.. toctree::
   :maxdepth: 1
   :glob:

   catalog-basics
   tape_archive
   basic-plotting-with-intake
   caching-average
   intake-variable-info
   ../playing_with_triangles/zonal_mean
   intake-cdo

Utilities
----------


.. toctree::
   find_files
   gem_helpers


Special cases:
--------------

.. toctree::
   :maxdepth: 1
   :glob:
      
   var_info_script
   grid-guessing-test


.. admonition:: Further reading

   * `The official Intake-ESM documentation <https://intake-esm.readthedocs.io/en/latest/>`__
   * `The Intake-ESM tutorials of DKRZ's Data Management team <https://tutorials.dkrz.de/intake.html>`__
     
   * `The Intake-ESM Tech Talk by Aaron Spring <https://indico.dkrz.de/event/31/>`__