.. _empymod-manual:

#####################
empymod Documentation
#####################

:Release: |version|
:Date: |today|
:Source: `github.com/emsig/empymod <https://github.com/emsig/empymod>`_

----

.. toctree::
   :hidden:

   manual/index
   gallery/index
   api/index
   dev/index


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

    .. grid-item-card::

        :fa:`book;fa-4x`

        User Guide
        ^^^^^^^^^^

        The manual contains installation instructions, information on how to
        get started, tips and tricks, background theory, how to cite empymod,
        important references, license information, and much more!

        +++

        .. button-ref:: manual
            :expand:
            :color: info
            :click-parent:

            To the user guide

    .. grid-item-card::

        :fa:`image;fa-4x`

        Gallery
        ^^^^^^^

        The gallery contains examples and tutorials on the usage of empymod, and is
        generally the best way to get started. Download them and modify them to
        your needs! It is also a good place to see what is possible with empymod.

        +++

        .. button-ref:: empymod_gallery
            :expand:
            :color: info
            :click-parent:

            To the gallery

    .. grid-item-card::

        :fa:`code;fa-4x`

        API reference
        ^^^^^^^^^^^^^

        The API reference of empymod is extensive, and includes almost every
        function and class. A lot of the underlying theory is described in the
        docstring of the functions, particularly in the ``kernel`` module.

        +++

        .. button-ref:: api
            :expand:
            :color: info
            :click-parent:

            To the API reference

    .. grid-item-card::

        :fa:`terminal;fa-4x`

        Developer guide
        ^^^^^^^^^^^^^^^

        empymod is a community code, please help to shape its future! From typos to
        bugs to new developments, every contribution is welcomed. This section is
        the best way to get started.

        +++

        .. button-ref:: development
            :expand:
            :color: info
            :click-parent:

            To the development guide

    .. grid-item-card::
        :columns: 12

        :fa:`comments;fa-4x`

        Contact
        ^^^^^^^

        .. button-link:: https://emsig.xyz/#contributing-contact
            :expand:
            :color: info
            :click-parent:

            Go to «Contributing & Contact» @ emsig.xyz

    .. grid-item-card::
        :columns: 12

        .. dropdown:: About the name and logo of empymod

            The name **empymod** is a portmanteau of *electromagnetic* (em),
            *python* (py), and *modelling* (mod): empymod is a an electromagnetic
            modeller in python.

            The name in the logo plays with the fact that *py* in python is
            pronounced the same as *pi*, the number. Pi is a fundamental constant
            in electromagnetic modelling.

            The symbol represents pi as well, with the three blue bars representing
            the integer part (3), and the red dot represents the fractional part
            (0.14159...).

            .. image:: ./_static/empymod-logo.svg