.. include:: ../common.txt

.. _gv-reference-about:
.. _tippy-gv-reference-about:

:fa:`circle-info` About
=======================

Assorted package metadata about ``geovista``.


:fa:`feather-pointed` Citation
------------------------------

.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7608302.svg
    :target: https://zenodo.org/doi/10.5281/zenodo.7608302

|zenodo|

If ``geovista`` has assisted with your academic research or work, then please
remember to cite us:

.. literalinclude:: ../../../CITATION.cff
    :language: text


.. _gv-reference-about-community:
.. _tippy-gv-reference-about-community:

:fa:`people-roof` Community
---------------------------

Head over to our :fab:`github` `Discussions`_ to engage with the
``geovista`` community. Feel free to ask questions, share ideas, discuss topics,
and even showcase your work in our :fab:`github` `🍬 Candy Store`_. Go for it!

Add a touch of panache to your :bash:`README.md` with our badge:

.. rst-class:: center

    |geovista-badge|


.. tab-set::

    .. tab-item:: html

        .. code:: html

            <a href="https://geovista.readthedocs.io/en/latest/" >
            <img alt="geovista-badge" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/bjlittle/geovista/main/docs/assets/badge/v0.json" />
            </a>

    .. tab-item:: markdown
        :selected:

        .. code:: markdown

            [![geovista-badge](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/bjlittle/geovista/main/docs/assets/badge/v0.json)](https://geovista.readthedocs.io/en/latest/)

    .. tab-item:: rst

        .. code:: rst

            .. |geovista-badge| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/bjlittle/geovista/main/docs/assets/badge/v0.json
                :target: https://geovista.readthedocs.io/en/latest/

.. tip::
   :class: dropdown

   Customize the look and feel of the badge by appending :bash:`&style=<option>`
   to the endpoint URL.

   See the `shields.io documentation`_ for further details.


:fa:`file-code` Packages
~~~~~~~~~~~~~~~~~~~~~~~~

.. comment

   ⚠️ please add packages to the table below in alphabetical order using
      a reference to the package URL defined at the bottom of this file


Discover community projects using ``geovista``:

.. table:: Third-Party Packages
    :align: center
    :name: tippy-gv-reference-about-community-packages
    :widths: 1 4

    +---------------------+---------------------------------------------------------------------------------+
    | Package             | Description                                                                     |
    +=====================+=================================================================================+
    | `aeolus`_           | A library for analysing and visualising atmospheric model output.               |
    +---------------------+---------------------------------------------------------------------------------+
    | `geojav`_           | Plume dataset visualization tool to assist paper submission to the              |
    |                     | `Journal of Applied Volcanology`_.                                              |
    +---------------------+---------------------------------------------------------------------------------+
    | `geovista-slam`_    | Generating Structured Local Area Model (SLAM) grids from unstructured meshes.   |
    +---------------------+---------------------------------------------------------------------------------+
    | `iris`_             | A powerful, format-agnostic, and community-driven Python package for analysing  |
    |                     | and visualising Earth science data.                                             |
    +---------------------+---------------------------------------------------------------------------------+
    | `ngview`_           | A GUI for loading NetCDF files; selecting the fields, levels and time points    |
    |                     | you want; and plotting the results using ``geovista``.                          |
    +---------------------+---------------------------------------------------------------------------------+
    | `uraster`_          | Transform raster datasets to unstructured meshes.                               |
    +---------------------+---------------------------------------------------------------------------------+


.. admonition:: Share with the community!
    :class: dropdown

    Click `here <https://github.com/bjlittle/geovista/edit/main/docs/src/reference/about.rst>`__ to
    add your project details and raise a :fa:`code-pull-request` `Pull-Request`_.


.. _gv-reference-about-community-publications:
.. _tippy-gv-reference-about-community-publications:

:fa:`file-waveform` Publications
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. comment

   ⚠️ please add bibtex entries into the "docs/src/refs.bib" file


Explore scientific publications that leverage ``geovista``:

.. bibliography::
    :all:


.. admonition:: Share with the community!
    :class: dropdown

    Click `here <https://github.com/bjlittle/geovista/edit/main/docs/src/refs.bib>`__ to
    add your BibTeX entry and raise a :fa:`code-pull-request` `Pull-Request`_.


:fa:`users` Contributors
------------------------

.. |all-contributors| image:: https://img.shields.io/github/all-contributors/bjlittle/geovista?color=ee8449

|all-contributors|

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

    Anyone can use the |icon| `all-contributors bot 🤖`_  to acknowledge
    the efforts of others (or yourself 😉).


We follow the |icon| `all-contributors`_ specification. Contributions of
any kind to ``geovista`` are welcome!

It's important that we recognise and acknowledge **all** our contributors, not
just the ones who push code. So no matter how large or small, we're grateful
for your contribution and caring enough to make a difference.

A massive thank-you to all our awesome contributors (`Emoji Key ✨`_):

.. include:: ../../../CONTRIBUTORS.md
    :parser: myst_parser.sphinx_


:fa:`file-contract` License
---------------------------

.. |bsd-3-clause| image:: https://img.shields.io/github/license/bjlittle/geovista
    :target: https://github.com/bjlittle/geovista/blob/main/LICENSE

|bsd-3-clause|

``geovista`` is an open-source package distributed under the terms of the
`BSD-3-Clause`_ license.

.. literalinclude:: ../../../LICENSE
    :language: text


.. comment

   🔗 URL resources in alphabetical order:

.. |icon| image:: https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg
.. _aeolus: https://github.com/exoclim/aeolus
.. _all-contributors: https://github.com/all-contributors/allcontributors.org
.. _all-contributors bot 🤖: https://allcontributors.org/en/bot/usage/#all-contributors-add
.. _BSD-3-Clause: https://spdx.org/licenses/BSD-3-Clause.html
.. _🍬 Candy Store: https://github.com/bjlittle/geovista/discussions/1033
.. _Emoji Key ✨: https://allcontributors.org/en/reference/emoji-key/
.. _geojav: https://github.com/bjlittle/geovista-jav-2026
.. _Journal of Applied Volcanology: https://link.springer.com/journal/13617
.. _ngview: https://github.com/MetOffice/ngview
.. _shields.io documentation: https://shields.io/
.. _uraster: https://github.com/changliao1025/uraster