:tocdepth: 3

#####################
pycraf Documentation
#####################


**Version**: |release|

**Useful links**:
:ref:`Installation <install>` |
`Issues & Ideas <https://github.com/bwinkel/pycraf/issues>`__ |
`Repository <https://github.com/bwinkel/pycraf>`__ |
:ref:`License information <license>`


Welcome to the pycraf documentation. The pycraf Python package provides
functions and procedures for various tasks related to spectrum-management
compatibility studies. This includes an implementation of `ITU-R
Recommendation P.452-16 <https://www.itu.int/rec/R-REC-P.452-16-201507-I/en>`_
that allows to calculate path attenuation for the distance between an
interferer and the victim service.

.. toctree::
   :maxdepth: 1
   :hidden:

   index_getting_started
   index_user_guide
   index_project_details
   index_acknowledgements

.. grid:: 2

    .. grid-item-card::

        Getting Started
        ^^^^^^^^^^^^^^^

        New to pycraf? Check out the getting started guides.

        +++

        .. button-ref:: index_getting_started
            :expand:
            :color: primary
            :click-parent:

            To the getting started guides

    .. grid-item-card::

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

        The user guide contains a detailed description of the various
        pycraf features and explanation, how to use them.

        +++

        .. button-ref:: index_user_guide
            :expand:
            :color: primary
            :click-parent:

            To the user guide

    .. grid-item-card::

        Project Details
        ^^^^^^^^^^^^^^^

        Information about licenses, etc.

        +++

        .. button-ref:: index_project_details
            :expand:
            :color: primary
            :click-parent:

            To the project details

    .. grid-item-card::

        Acknowledgments
        ^^^^^^^^^^^^^^^

        +++

        .. button-ref:: index_acknowledgements
            :expand:
            :color: primary
            :click-parent:

            To the acknowledgments


.. .. automodapi:: pycraf
..     :no-heading:
..     :no-main-docstr:



.. |apu| replace:: `astropy.units`