.. geocat-comp documentation master file, created by
   sphinx-quickstart on Mon Aug 19 14:29:04 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. module:: geocat.comp

.. meta::
   :description: GeoCAT-comp Python module
   :keywords: geocat, geocat-comp, geocat comp, geocatcomp, geocat.comp,
              wrf, python, wrf-python, weather research and forecasting,
              weather research and forecasting model, model, weather,
              numerical weather prediction, model, matplotlib, cartopy,
              wrf-arw, arw, ncar, nsf, nsf ncar, ucar, cisl, ncl,
              ncar command language, nsf national center for atmospheric research,
              university corporation for atmospheric research,
              pynio, pyngl, interpolation


.. .. image:: _static/images/nsf.png
..    :scale: 100%
..   :align: right

.. |
.. |

GeoCAT-comp Documentation
=========================

GeoCAT-comp is computational component of the `GeoCAT <https://geocat.ucar.edu/>`__
project. GeoCAT-comp provides implementations of computational functions for operating
on geosciences data. Many of these functions originated in NCL and were translated into
Python with the help of GeoCAT-comp; however, developers are welcome to come up with
novel computational functions for geosciences data.

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

    .. grid-item-card:: Getting Started
        :class-title: custom-title
        :class-body: custom-body
        :img-top: _static/images/icons/tips.svg
        :link: getting-started
        :link-type: doc

        A good place to start for new users

    .. grid-item-card::  Examples
        :class-title: custom-title
        :class-body: custom-body
        :img-top: _static/images/icons/science.svg
        :link: examples
        :link-type: doc

        A gallery of examples using GeoCAT-comp

    .. grid-item-card::  Installation
        :class-title: custom-title
        :class-body: custom-body
        :img-top: _static/images/icons/download.svg
        :link: installation
        :link-type: doc

        Installation instructions for GeoCAT-comp

    .. grid-item-card::  API
        :class-title: custom-title
        :class-body: custom-body
        :img-top: _static/images/icons/code.svg
        :link: api
        :link-type: doc

        See the complete GeoCAT-comp API

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: For Users

   Getting Started <getting-started>
   Installation <installation>
   API Reference <api>
   Usage Examples <examples>
   Cite GeoCAT-comp <citation.rst>
   NCL Documentation <https://www.ncl.ucar.edu/>

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: For Developers

   Release Notes <release-notes.rst>
   Contributor's Guide <contrib.rst>

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Getting Support

   Support <support>
   GitHub Issues <https://github.com/NCAR/geocat-comp/issues>
   Suggestion Box <https://forms.gle/6DTo3ELLri4DAGfG8>