.. dropdown:: Distribution Statement

 | # # # This source code is subject to the license referenced at
 | # # # https://github.com/NRLMMD-GEOIPS.

:notoc:

.. module:: geoips
   :noindex:

****************************************************************
GeoIPS |reg| geoips Documentation
****************************************************************

**Date**: |today| **Version**: |release|

**Previous versions**: Documentation of previous geoips versions are available at
`github.com/NRLMMD-GEOIPS <https://github.com/NRLMMD-GEOIPS/>`__.

**Useful links**:
`Source Repository <https://github.com/NRLMMD-GEOIPS/geoips>`__ |
`GeoIPS License <https://github.com/NRLMMD-GEOIPS/geoips/blob/main/LICENSE>`__ |
`NRLMMD <https://www.nrlmry.navy.mil/>`__ |

:mod:`geoips` is a free software program, using the NRL Open License Agreement.

::

    Distribution Statement A. Approved for public release. Distribution is unlimited.

    This source code is protected under the license referenced at
    https://github.com/NRLMMD-GEOIPS.

.. automodule:: geoips
   :noindex:

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

    .. grid-item-card:: Getting Started

        .. image:: _static/index_user_guide.png
           :alt: getting-started
           :scale: 25%
           :align: center

        The getting started guide can help you get started with using
        geoips.

        .. button-link:: getting-started/index.html
            :ref-type: ref
            :color: secondary
            :expand:
            :click-parent:

            Getting Started

    .. grid-item-card:: The API reference guide

        .. image:: _static/index_api.png
           :alt: API Reference
           :scale: 25%
           :align: center

        The reference guide contains a detailed description of geoips API.
        The reference describes how the methods work and which parameters can
        be used. It assumes that you have an understanding of the key concepts.

        .. button-link:: api/index.html
            :ref-type: ref
            :color: secondary
            :expand:
            :click-parent:

            API

    .. grid-item-card:: To the release notes

        .. image:: _static/index_contribute.png
           :alt: release notes
           :scale: 25%
           :align: center

        Change logs, versioning and contribution history.

        .. button-link:: releases/index.html
            :ref-type: ref
            :color: secondary
            :expand:
            :click-parent:

            Release Notes

.. toctree::
    :maxdepth: 3
    :hidden:
    :titlesonly:

    getting-started/index
    
    
    tutorials/index
    
    concepts/index
    
    
    
    contribute/index
    geoips_api/index
    releases/index
    contact/index

.. |reg|    unicode:: U+000AE .. REGISTERED SIGN