.. title:: Home

.. grid::
    :gutter: 2 3 3 3
    :margin: 5 5 0 0
    :padding: 0 0 0 0

    .. grid-item::
        :columns: 12 8 8 8

        .. raw:: html

            <h1 class="display-1">SrTomo</h1>

        .. div:: sd-fs-3

            Straight-ray traveltime tomography for teaching inverse problems


**SrTomo** (pronounced "Señor Tomo") is a Python package made for teaching
fundamental concepts in linear inverse problems. It makes it simple to calculate
Jacobian/sensitivity matrices for the straight-ray travel time tomography
problem, plot data and results, and implement different types of regularization.

.. seealso::

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

.. grid:: 1 2 1 2
    :margin: 5 5 0 0
    :padding: 0 0 0 0
    :gutter: 4

    .. grid-item-card:: :octicon:`rocket` Getting started
        :text-align: center
        :class-title: sd-fs-5
        :class-card: sd-p-3

        New to SrTomo? Start here!

        .. button-ref:: overview
            :click-parent:
            :color: primary
            :outline:
            :expand:

    .. grid-item-card:: :octicon:`comment-discussion` Need help?
        :text-align: center
        :class-title: sd-fs-5
        :class-card: sd-p-3

        Ask on our community channels

        .. button-link:: https://www.fatiando.org/contact
            :click-parent:
            :color: primary
            :outline:
            :expand:

             Join the conversation

    .. grid-item-card:: :octicon:`file-badge` Reference documentation
        :text-align: center
        :class-title: sd-fs-5
        :class-card: sd-p-3

        A list of modules and functions

        .. button-ref:: api
            :click-parent:
            :color: primary
            :outline:
            :expand:

    .. grid-item-card:: :octicon:`bookmark` Using SrTomo in your class?
        :text-align: center
        :class-title: sd-fs-5
        :class-card: sd-p-3

        Citations help support our work

        .. button-ref:: citing
            :click-parent:
            :color: primary
            :outline:
            :expand:

----

Project status
--------------

**SrTomo is in early stages of design and implementation**. This means that APIs
and results may change between releases.

**We welcome feedback and ideas!** This is a great time to bring new
ideas on how we can improve the project. `Join the
conversation <https://www.fatiando.org/contact>`__ or submit `issues on
GitHub <https://github.com/fatiando/srtomo/issues>`__.

Getting involved
----------------

🗨️ **Contact us:** Find out more about how to reach us at
`fatiando.org/contact <https://www.fatiando.org/contact/>`__.

👩🏾‍💻 **Contributing to project development:** Please read our
`Contributing
Guide <https://github.com/fatiando/srtomo/blob/main/CONTRIBUTING.md>`__
to see how you can help and give feedback.

🤖 **Policy on AI usage:**
Please read our
`AI Usage Policy <https://github.com/fatiando/community/blob/main/AI.md>`__.

🧑🏾‍🤝‍🧑🏼 **Code of conduct:** This project is released with a `Code of
Conduct <https://github.com/fatiando/community/blob/main/CODE_OF_CONDUCT.md>`__.
By participating in this project you agree to abide by its terms.

    **Imposter syndrome disclaimer:** We want your help. **No, really.** There
    may be a little voice inside your head that is telling you that you’re
    not ready, that you aren’t skilled enough to contribute. We assure you
    that the little voice in your head is wrong. Most importantly, **there are
    many valuable ways to contribute besides writing code** (giving feedback,
    teaching, writing documentation, and more).

    *This disclaimer was adapted from the* `MetPy
    project <https://github.com/Unidata/MetPy>`__.

License
-------

This is free software: you can redistribute it and/or modify it under
the terms of the **BSD 3-clause License**. A copy of this license is
provided in the
`LICENSE.txt <https://github.com/fatiando/srtomo/blob/main/LICENSE.txt>`__
file.


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

    overview.rst
    install.rst

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

    tutorial/index.rst
    how-to/index.rst

.. toctree::
    :maxdepth: 1
    :hidden:
    :caption: Reference Documentation

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


.. toctree::
    :maxdepth: 1
    :hidden:
    :caption: Community

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