.. include:: common.txt

.. _gv-root:

GeoVista Documentation
======================

.. note::
    :class: margin, dropdown, toggle-shown

    Content marked with 🚧 indicates it's still under construction.


Welcome to the ``geovista`` documentation!

``geovista`` is a pure `Python`_ package, built upon `PyVista`_ that offers
performant, publication quality 3-D cartographic rendering of Earth Science
data.

Our goal is to lower the bar for scientists, such that they can easily
analyze, visualize, and explore their rectilinear, curvilinear and
unstructured geospatial data interactively in 3-D.

We're still busy crafting the documentation, which is incomplete and liable
to change.  Thanks for your patience. However, your feedback is important
to us.  So feel free to submit a :fab:`github` `Issue`_  or
:fab:`github` `Pull-Request`_ to help elevate ``geovista`` to the next level
of awesome 🚀

Alternatively, come share with us over on our :fab:`github` `Discussions`_.
We'd 💛 to hear from you.


----


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

    .. grid-item-card:: Tutorials
        :class-title: custom-title
        :class-body: custom-body
        :link: gv-tutorials
        :link-type: ref
        :img-top: _static/images/icons/tutorials.svg
        :class-img-top: dark-light
        :class-card: sd-rounded-3

        Topic driven themed lessons.

    .. grid-item-card:: 🚧 How-To Guides
        :class-title: custom-title
        :class-body: custom-body
        :link: gv-howtos
        :link-type: ref
        :img-top: _static/images/icons/howtos.svg
        :class-img-top: dark-light
        :class-card: sd-rounded-3

        Treasure trove of focused guides.

    .. grid-item-card:: 🚧 Explanation
        :class-title: custom-title
        :class-body: custom-body
        :link: gv-explanation
        :link-type: ref
        :img-top: _static/images/icons/explanation.svg
        :class-img-top: dark-light
        :class-card: sd-rounded-3

        Deeper understanding awaits.

    .. grid-item-card:: Reference
        :class-title: custom-title
        :class-body: custom-body
        :link: gv-reference
        :link-type: ref
        :img-top: _static/images/icons/reference.svg
        :class-img-top: dark-light
        :class-card: sd-rounded-3

        No fuss facts.


.. rst-class:: center

    :fa:`graduation-cap` Choose your approach to learning and ``geovista``
    knowledge discovery (`Diátaxis`_)


.. include:: gallery-carousel.txt


.. toctree::
    :caption: GeoVista 101
    :maxdepth: 1
    :hidden:

    overview
    installation
    quick_start
    next_steps


.. toctree::
    :caption: Contents
    :maxdepth: 1
    :hidden:

    tutorials/index
    howtos/index
    explanation/index
    reference/index


.. toctree::
    :caption: Gallery
    :maxdepth: 1
    :hidden:

    generated/gallery/index
    tags/tagsindex


.. toctree::
    :caption: Developer
    :maxdepth: 1
    :hidden:

    developer/index