.. geocat-viz documentation master file, created by
   sphinx-quickstart on Wed Apr 26 12:02:04 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. module:: geocat.viz

.. meta::
   :description: GeoCAT-viz Python module
   :keywords: geocat, geocat-viz, geocat viz, geocatviz, geocat.viz,
              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, ucar, cisl, ncl, ncar command language,
              national center for atmospheric research,
              university corporation for atmospheric research,
              pynio, pyngl, interpolation, visualization, data visualization,
              plotting, python plotting


.. |
.. |

GeoCAT-viz Documentation
========================

The GeoCAT-viz repo contains tools to help plot data, including convenience and plotting functions that are used
to facilitate plotting geosciences data with Matplotlib, Cartopy, and possibly other Python ecosystem
plotting packages.

.. 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-viz

    .. 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-viz

    .. 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-viz API

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

   Getting Started <getting-started>
   Installation <installation>
   API Reference <api>
   Usage Examples <examples>
   Cite GeoCAT-viz <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-viz/issues>
   Feature Request Form <https://forms.gle/6DTo3ELLri4DAGfG8>