.. torchquad documentation master file, created by
   sphinx-quickstart on Fri Nov 20 14:20:34 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. image:: Torchquad_RtD_background.png
    :width: 530px
    :align: center
    :height: 227px
    :alt: torchquad_logo


.. image:: https://readthedocs.org/projects/torchquad/badge/?version=main
   :target: https://torchquad.readthedocs.io/en/main/?badge=main
   :alt: Documentation Status

.. image:: https://img.shields.io/github/workflow/status/esa/torchquad/Running%20tests/develop
   :target: https://img.shields.io/github/workflow/status/esa/torchquad/Running%20tests/develop
   :alt: GitHub Workflow Status (branch)

.. image:: https://img.shields.io/github/last-commit/esa/torchquad
   :target: https://img.shields.io/github/last-commit/esa/torchquad
   :alt: GitHub last commit

.. image:: https://img.shields.io/github/license/esa/torchquad
   :target: https://img.shields.io/github/license/esa/torchquad
   :alt: GitHub license

.. image:: https://img.shields.io/conda/vn/conda-forge/torchquad
   :target: https://img.shields.io/conda/vn/conda-forge/torchquad
   :alt: Conda (channel only)

.. image:: https://img.shields.io/pypi/v/torchquad
   :target: https://img.shields.io/pypi/v/torchquad
   :alt: PyPI Version

.. image:: https://img.shields.io/pypi/pyversions/torchquad
   :target: https://img.shields.io/pypi/pyversions/torchquad
   :alt: PyPI - Python Version

.. image:: https://img.shields.io/github/contributors/esa/torchquad
   :target: https://img.shields.io/github/contributors/esa/torchquad
   :alt: GitHub contributors

.. image:: https://img.shields.io/github/issues/esa/torchquad
   :target: https://img.shields.io/github/issues/esa/torchquad
   :alt: GitHub issues

.. image:: https://img.shields.io/github/issues-pr/esa/torchquad
   :target: https://img.shields.io/github/issues-pr/esa/torchquad
   :alt: GitHub pull requests

.. image:: https://img.shields.io/conda/dn/conda-forge/torchquad
   :target: https://img.shields.io/conda/dn/conda-forge/torchquad
   :alt: Conda

.. image:: https://img.shields.io/pypi/dm/torchquad
   :target: https://img.shields.io/pypi/dm/torchquad
   :alt: PyPI - Downloads

.. image:: https://joss.theoj.org/papers/d6f22f83f1a889ddf83b3c2e0cd0919c/status.svg
   :target: https://joss.theoj.org/papers/d6f22f83f1a889ddf83b3c2e0cd0919c
   :alt: JOSS Status


Welcome to torchquad's documentation!
=====================================================

*torchquad* is a Python3 module for multidimensional numerical integration on the GPU.
It uses `autoray <https://github.com/jcmgray/autoray>`_ to support
`PyTorch <https://pytorch.org/>`_ and
:ref:`other machine learning modules <tutorial_backend_selection>`.

You can see the latest code at https://github.com/esa/torchquad.

.. toctree::
   :maxdepth: 2
   :caption: Overview:

   install
   tutorial
   integration_methods
   autodoc


.. toctree::
   :maxdepth: 1
   :caption: Contact:

   contact
   contributing

Roadmap
---------

See the `open issues <https://github.com/esa/torchquad/issues>`_ for a list of proposed features (and known issues).


License
--------

Distributed under the GPL-3.0 License. See `LICENSE <https://github.com/esa/torchquad/blob/main/LICENSE>`_ for more information.


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
