.. caustics documentation master file, created by
   sphinx-quickstart on Thu Jun  1 09:33:32 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. image:: https://github.com/Ciela-Institute/caustics/blob/main/media/caustics_logo.png?raw=true
   :width: 100 %
   :target: https://github.com/Ciela-Institute/caustics
   
|br|

Welcome to Caustics' documentation!
===================================

The lensing pipeline of the future: GPU-accelerated, automatically-differentiable, highly modular and extensible.

.. note::

    Caustics is in its early development phase. This means the API will change with time. These changes are a good thing, but they can be annoying. Watch the version numbers, when we get to 1.0.0 that will be the first stable release!

Intallation
===========

The easiest way to install is to make a new virtual environment then run::

    pip install caustics

this will install all the required libraries and then install caustics and you are ready to go! You can check out the tutorials afterwards to see some of caustics's capabilities.  If you want to help out with building the caustics code base check out the developer installation instructions instead.

Read The Docs
=============

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   getting_started.rst
   install.rst
   tutorials.rst
   contributing.rst
   citation.rst
   license.rst
   
Indices and tables
==================

.. toctree::
   :maxdepth: 1

   modules.rst
   
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`