***************************************************
SPRING
***************************************************
------------------------------------------------------------------------------
the Simple Phase Retrieval In the Nux Group
------------------------------------------------------------------------------
**... for Single Particle Reconstruction with coherent diffraction ImagiNG**
Welcome to the SPRING module documentation!
*Spring* is a Python module for single-particle single-shot Coherent Diffraction Imaging data analysis, developed by the `NUX group `_.
It is designed to be **user-friendly** and to run on **interactive Python notebooks** like `Jupyter `_.
It's implementation makes an efficient use of multi-CPU and multi-GPU computing hardware.
After the :doc:`install` step, have a look at the :doc:`quickstart` section for an easy introduction to the main features of *spring*.
Source code
^^^^^^^^^^^
The *spring* source code is hosted on `ETH Zurich GitLab `_ and available as Open Source Software under MIT licence (see ``LICENSE`` file).
Contacts
^^^^^^^^^
The source code is maintained by `Alessandro Colombo (ETH Zurich) `_. Please contact alcolombo@phys.ethz.ch for any question, issue or suggestion!
Citing
^^^^^^^
In publications, please cite the following papers:
- Colombo, Alessandro, et al. *Facing the phase problem in coherent diffractive imaging via memetic algorithms*, Scientific reports 7.1 (2017): 42236. **DOI:** `10.1038/srep42236 `_
- Colombo, Alessandro, et al, *An effective and reliable approach to the phase problem in single-shot single-particle Coherent Diffraction Imaging*, arXiv preprint (2024). **DOI:** `10.48550/arXiv.2409.07413 `_
.. toctree::
:maxdepth: 2
:caption: Contents:
install
quickstart
workflow
hardware
reference