.. fret-tester documentation master file, created by
   sphinx-quickstart on Fri Jan 19 13:28:26 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Documentation of the `fret-tester` python package
=================================================

This is a software implementation of the smFRET kinetics analysis method
described in the Journal of Chemical Physics article “Kinetic analysis of
single molecule FRET transitions without trajectories” [1]_, which
was used to perform the data anlysis for the article.

The source code including an extensive tutorial can be found on
`github <https://github.com/schuetzgroup/fret-tester>`_.

.. [1] Schrangl, Lukas; Göhring, Janett; Schütz, Gerhard J. (2018):
  “Kinetic analysis of single molecule FRET transitions without trajectories.”
  In: The Journal of Chemical Physics, 148 (2018), H. 12, p. 123328.
  Available at: `DOI: 10.1063/1.5006038 <https://doi.org/10.1063/1.5006038>`_


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

   time_trace
   fluo_models
   ks_test
   plot
   utils



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

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