.. CalCIL documentation master file, created by
   sphinx-quickstart on Sun Jul 28 15:48:15 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to CalCIL's documentation!
==================================

**CalCIL** is a computational imaging library that provides gradient descent-based image reconstruction tools.
It is designed to be modular and extensible, with a focus on ease of use and reproducibility. CalCIL is built on top of JAX and Flax.

Features
--------
- 🧠 brainless gradient descent-based image reconstruction
- 🤓 fully customizable loss functions
- 🫡 auto logging and visualization via tensorboard
- 😬 flexible optimization parameters (variable specific settings, learning rate schedule, etc.)
- 🤯 post-update custom functions
- 🔮 handy helper functions for interactive 3/4D visualization on jupyter notebook




.. toctree::
   installation
   getting_started
   history
   source/modules
   :maxdepth: 2
   :caption: Contents:



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

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