******************************
Welcome to toupy documentation
******************************

**Toupy** is a suite of tools for the processing of high-resolution tomography dataset compiled by
J. C. da Silva and licensed under the `GPLv3 license <https://choosealicense.com/licenses/gpl-3.0/>`_ .

The name **toupy** stands for **Tomographic Utilites for Python** and it is a wordplay with the French
word `toupie` for spinning top, the toy designed to spin rapidly on the ground, the motion of
which causes it to remain precisely balanced on its tip due to its rotational inertia. Here you can
find the wikipedia page in `English <https://en.wikipedia.org/wiki/Top>`_ and in `French <https://fr.wikipedia.org/wiki/Toupie_(jouet)>`_.

**Toupy** implements tools for preprocessing the projections before the tomographic reconstruction
and the reconstruction itself. The pipeline and algorithms is briefly summarized in this publication [#algos]_, but which is also based on
previous works [#psi]_.

Quicklinks
----------
* Get started quickly with the examples in the :doc:`templates <templates>` directory.

* The complete :ref:`documentation <contents_toupy>`.

* The source code can be obtained via `Github repo of toupy <https://github.com/jcesardasilva/toupy>`_ .

References
----------

.. [#algos] da Silva, J. C., Haubrich, J., Requena, G., Hubert, M., Pacureanu, A., Bloch, L., Yang, Y., Cloetens, P.,
            *High energy near-and far-field ptychographic tomography at the ESRF*.
            **Proc. SPIE** 10391, Developments in X-Ray Tomography XI, 1039106 (2017). `doi <http://dx.doi.org/10.1117/12.2272971>`__
.. [#psi] Guizar-Sicairos, M., Diaz, A., Holler, M., Lucas, M. S., Menzel, A., Wepf, R. A., and Bunk, O., *Phase
          tomography from x-ray coherent diffractive imaging projections*, **Opt. Express** 19, 21345–21357
          (2011). `doi <http://dx.doi.org/10.1364/OE.19.021345>`__

Acknowledgments
---------------

* Ana Diaz, PSI, Switzerland
* Andreas Menzel, PSI, Switzerland
* Manuel Guizar-Sicairos, PSI, Switzerland
* Pierre Paleo, ESRF, France
* Peter Cloetens, ESRF, France