.. title:: Home

.. raw:: html

    <h1 class="display-2 text-center">
      Boule
    </h1>

    <p class="lead text-center front-page-callout">
      Reference ellipsoids for geodesy and geophysics
    </p>

.. admonition:: This software is in the early stages of design and implementation
    :class: attention

    This means that will occasionally make **backwards incompatible** changes
    as we try to improve the software, test new ideas, and settle on the
    project scope.
    **We welcome any feedback and ideas!** Let us know by submitting
    `issues on Github <https://github.com/fatiando/boule/issues>`__
    or send us a message on our
    `Slack chatroom <http://contact.fatiando.org>`__.

.. seealso::

    Boule is a part of the
    `Fatiando a Terra <https://www.fatiando.org/>`_ project.

.. include:: ../README.rst
    :start-after: placeholder-for-doc-index

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

    tutorials/overview.rst
    install.rst

.. toctree::
    :maxdepth: 2
    :hidden:
    :caption: User Guide

    ellipsoids/index.rst
    tutorials/normal_gravity.rst
    tutorials/geodetic_to_geocentric.rst

.. toctree::
    :maxdepth: 2
    :hidden:
    :caption: Reference

    api/index.rst
    citing.rst
    changes.rst
    references.rst
    versions.rst

.. toctree::
    :maxdepth: 2
    :hidden:
    :caption: Community

    Join the community <http://contact.fatiando.org>
    How to contribute <https://github.com/fatiando/boule/blob/master/CONTRIBUTING.md>
    Code of Conduct <https://github.com/fatiando/boule/blob/master/CODE_OF_CONDUCT.md>
    Source code on GitHub <https://github.com/fatiando/boule>
    The Fatiando a Terra project <https://www.fatiando.org>