.. GlobalBioIm Library documentation master file, created by
   sphinx-quickstart on Sun Jun 25 15:32:10 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.
   
Welcome to the GlobalBioIm Library Webpage
******************************************

This is a free Matlab library. It contains generic modules that facilitate the implementation of forward models and optimization
algorithms. It also capitalizes on the
strong commonalities between the various image-formation models that can be exploited to build a fast, 
streamlined code.

.. figure:: button.png
   :scale: 40 %
   :align: center
   :target: https://github.com/Biomedical-Imaging-Group/GlobalBioIm


This page contains the detailed documentation of each function/class of the library. The documentation is generated 
automatically from comments within M-files. 


Releases
--------

  - `v 1.2 <https://github.com/Biomedical-Imaging-Group/GlobalBioIm/releases/tag/v1.2>`_ (January 2021). *Generate your script through the GUI* (:ref:`read more <ref-gui>`).
  - `v 1.1.2 <https://github.com/Biomedical-Imaging-Group/GlobalBioIm/releases/tag/v1.1.2>`_ (April 2019).
  - `v 1.1.1 <https://github.com/Biomedical-Imaging-Group/GlobalBioIm/releases/tag/v1.1.1>`_ (September 2018).
  - `v 1.1 <https://github.com/Biomedical-Imaging-Group/GlobalBioIm/releases/tag/v1.1>`_ (July 2018). *Speed up your codes using the library with GPU* (:ref:`read more <ref-gpu>`).
  - `v 1.0.1 <https://github.com/Biomedical-Imaging-Group/GlobalBioIm/releases/tag/v1.0.1>`_ (May 2018).
  - `v 1.0 <https://github.com/Biomedical-Imaging-Group/GlobalBioIm/releases/tag/v1.0>`_ milestone (March 2018). 
  - `v 0.2 <https://github.com/Biomedical-Imaging-Group/GlobalBioIm/releases/tag/v0.2>`_ (November 2017). *New tools, more flexibility, improved composition*.
  -  v 0.1 (June 2017). *First public release of the library.*

Reference
---------

| `Pocket Guide to Solve Inverse Problems with GlobalBioIm <https://iopscience.iop.org/article/10.1088/1361-6420/ab2ae9>`_,
| Inverse Problems, 35-10, 2019.
| E. Soubies, F. Soulez, M. T. McCann, T-A. Pham, L. Donati, T. Debarre, D. Sage, and M. Unser.


Acknowledgements
----------------

.. image:: Logo-ERC.png
   :width: 15 %
.. image:: EPFL_Logo_Digital_RGB_PROD.png
   :width: 32 %
.. image:: Logo-CIBM_variation-colour-72dpi.png
   :width: 48 %

GlobalBioIm acknowledges the support of the `European Research Council <https://erc.europa.eu/>`_, the  `École Polytechnique Fédérale de Lausanne <https://epfl.ch>`_, in Lausanne, Switzerland, and the `CIBM Center for Biomedical Imaging <https://cibm.ch>`_, in Switzerland.


Contents
********

.. toctree::
   :maxdepth: 1
   :caption: General

   Download or Clone (v 1.2) <https://github.com/Biomedical-Imaging-Group/GlobalBioIm>
   infos
   examples
   gui
   relatedPapers     
   conditionsuse

.. toctree::
   :maxdepth: 1
   :caption: Technical Documentation

   abstract
   linop
   nonlinop
   cost
   opti
   methodssummary
   propertiessummary
   gpu

.. toctree::
   :maxdepth: 1
   :caption: Links

   Biomedical Imaging Group <http://bigwww.epfl.ch>
   contact
   
 
.. default-domain:: mat

.. Hack to force MathJax insertion
.. math::