DiffeRT: Differentiable Ray Tracing Toolbox for Radio Propagation
=================================================================

DiffeRT is a Python module that aims to make *Differentiable Ray Tracing* accessible
to researchers in radio propagation!

It is currently developed as part of a PhD, but a lot of work is put into documenting and
testing the tool, so any researcher should be able to understand how to use this tool for
their own research.

As mentioned on the GitHub page, the current state of the project is still considered to
be under *high-development*, and we welcome any contribution!

Contents
--------

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

   installation
   conventions
   motivations
   limitations

.. toctree::
   :caption: Basic Tutorials
   :maxdepth: 1

   notebooks/quickstart
   notebooks/advanced_path_tracing
   notebooks/plotting_backend
   notebooks/diffraction
   notebooks/ray_tracing_at_city_scale

.. toctree::
   :caption: Advanced Tutorials
   :maxdepth: 1

   notebooks/multipath
   notebooks/sampling_paths

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

   API <api_reference>
   guides
   contributing
   changelog
   citing
   references
   Report an issue <https://github.com/jeertmans/DiffeRT/issues>
