glotaran / pyglotaran

A Python library for Global and Target Analysis of time-resolved spectroscopy data
GNU Lesser General Public License v3.0
54 stars 18 forks source link
data-analysis glotaran modelling pyglotaran python-library target-analysis

pyglotaran

PyPI version Conda Version Tests Documentation Status Coverage Status CodeQL Discord DOI

A framework written in Python for global and target analysis; commonly used for the analysis of time-resolved spectroscopy measurements in the study of energy transfer pathways in photosynthesis, or the characterization of energy transfer (in-)efficiencies in photovoltaics.

The Future of Global and Target Analysis

A scientific publication titled "pyglotaran: a lego-like Python framework for global and target analysis of time-resolved spectra" (DOI: 10.1007/s43630-023-00460-y) covers aspects of the architecture and the design of the software while illustrating its flexibility as an analysis tool through some exciting case studies. This publication, along with other pyglotaran-publications demonstrates why we believe this framework is the future of global and target analysis.

Usage of pyglotaran

If you just want to get started analyzing your data, jump straight to the getting started guide that is part of our documentation.

Afterwards, you may also want to have a look at our comprehensive collection of real-world examples in the pyglotaran-examples repository. There most like is an example that aligns well with your use case.

For state of the art usage of this framework you may want to check out the list of pyglotaran-publications.

Example analysis results

Results of a target analysis of Photosystem I (see study_florescence in the examples.)

overview plot of the fluorescence case study from the pyglotaran-examples Plot created with the plot_overview function of the pyglotaran-extras package.

Notice: This is (still) an early access release, please refer to the usage notice prior to committing to use pyglotaran to avoid surprises down the line.

Glotaran legacy

The pyglotaran package derives its name from the Glotaran software package (now called glotaran-legacy), first released in 2011 and described in a highly-cited publication in the Journal of Statistical Software, under the title Glotaran: A Java-Based Graphical User Interface for the R Package TIMP (DOI: 10.18637/jss.v049.i03).

The pyglotaran framework can be considered the spiritual successor of the glotaran-legacy software and has the backing of many of its original creators.

Community Support

For questions / suggestion please reach out to us via:

  1. GitHub issues
  2. Discord
  3. Google-Groups mailing list

Credits

The credits can be found in the documentation authors section