pycorrfit 1.0.0

Scientific tool for fitting correlation curves on a logarithmic plot.

A graphical fitting tool for fluorescence correlation spectroscopy (FCS) that comes with support for several file formats, can be applied to a large variety of problems, and attempts to be as user-friendly as possible. Some of the features are

• Averaging of curves

• Background correction

• Batch processing

• Overlay tool to identify outliers

• Fast simulation of model parameter behavior

• Session management

• User-defined model functions

• High quality plot export using LaTeX (bitmap or vector graphics)

Getting started

Installation

Installers for PyCorrFit are available at the release page.

Documentation

A detailed documentation including an explanation of the graphical user interface and available model functions is available as a PDF file.

Wiki

If you are interested in a specific topic or wish to contribute with your own HowTo, have a look at the PyCorrFit wiki. There you will also find information on how to write your own model functions.

Problems

If you find a bug or need help with a specific topic, do not hesitate to ask a question at the issues page.

Advanced usage

If you have Python installed you can install PyCorrFit, including its scripting functionalities, from the Python package index:

pip install pycorrfit[GUI]

More information is available in the PyCorrFit wiki.

Information for developers

Running from source

The easiest way to run PyCorrFit from source is to use Anaconda. PyCorrFit requires wxPython which is not available at the Python package index. Make sure you install a unicode version of wxPython. Detailed installation instructions are here.

Contributing

The main branch for developing PyCorrFit is develop. Small changes that do not break anything can be submitted to this branch. If you want to do big changes, please (fork ShapeOut and) create a separate branch, e.g. my_new_feature_dev, and create a pull-request to develop once you are done making your changes. Please make sure to also update the changelog.

Tests

PyCorrFit is tested using pytest. If you have the time, please write test methods for your code and put them in the tests directory. You may run the tests manually by issuing:

python setup.py test

Windows test binaries

After each commit to the PyCorrFit repository, a binary installer is created by Appveyor. Click on a build and navigate to ARTIFACTS (upper right corner right under the running time of the build). From there you can download the Windows installer of the commit.