.. currentmodule:: geocat.comp

.. _getting-started:

Getting Started
===============
This is a quick guide to getting set up and familiar with GeoCAT-comp. You'll get an overview of what geocat-comp is,
why we made it, and what functionalities it provides. You'll also get quick installation instructions and some simple
examples to get you started.

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

    .. grid-item-card:: Overview
        :class-title: custom-title
        :class-body: custom-body
        :img-top: _static/images/icons/handshake.svg
        :link: getting_started/overview.rst

        Get aquainted with GeoCAT-comp

    .. grid-item-card::  Quick Installation
        :class-title: custom-title
        :class-body: custom-body
        :img-top: _static/images/icons/electric_bolt.svg
        :link: getting_started/quick-install.rst

        The most basic installation instructions for GeoCAT-comp

    .. grid-item-card::  Basic Examples
        :class-title: custom-title
        :class-body: custom-body
        :img-top: _static/images/icons/menu_book.svg
        :link: getting_started/mini-examples.rst

        A few intro examples to get you started

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

   Overview <getting_started/overview.rst>
   Quick Installation <getting_started/quick-install.rst>
   Basic Examples <getting_started/mini-examples.rst>