jackyko1991 / FCS_point_correlator

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

FoCuS-point

Python TCSPC (Time Correlated Single Photon Counting) FCS (Fluorescence Correlation Spectroscopy) data visualiser.

This is source code repository for FoCuS-point software. For full details please refer to the project website: FoCuS-point project page.

The latest and historical releases of the software and manual for Windows, Linux and OSX are available through the following link and allows immediate access to FoCuS-point technique: Click for Releases

Futhermore, the software can be directly installed using pip.

Installation

Windows/ Ubuntu 20.04/ MacOS

To match modern python standard, we recommend the use of miniforge over Anaconda with better environment control efficiency.

  1. Install Anaconda/miniforage with proper bash initialization.
  2. Create virtual environment
    mamba create -n focus python=3.10 -y
  3. Activate the virtual environment
    mamba activate focus
    pip install numpy
  4. Install the package from Github directly
    pip install git+https://github.com/jackyko1991/FCS_point_correlator/ --upgrade

Local Installation (For Development Only)

  1. Install Anaconda/miniforage with proper bash initialization.
  2. Create virtual environment
    mamba create -n focus python=3.10 -y
  3. Activate the virtual environment
    mamba activate focus
    pip install numpy
  4. Clone the repository to local
    git clone git@github.com:jackyko1991/FCS_point_correlator.git
    cd FCS_point_correlator
  5. Install the package from Github directly
    pip install -e .

Ubuntu 14.04 (Deprecated)

sudo apt-get install python-setuptools python-dev build-essential git-all (to install pip, might not need).
sudo easy_install pip (to install pip, might not need).
sudo pip install —upgrade virtualenv numpy
sudo apt-get install libpng-dev libfreetype6-dev (Matplotlib dependencies)
sudo -H pip install git+https://github.com/dwaithe/FCS_point_correlator/ -upgrade (should work for all OS as long as the dependencies are met).

Verify Installation

python -m focuspoint.FCS_point_correlator

FAQ

  1. What datafiles does FoCuS-point support?

    Presently FoCuS-point supports .pt3 and .ptu uncorrelated files and under the fitting tab the FoCuS-point software supports .SIN and .fcs correlated files and .csv files correlated in FoCuS-point's own format.

  2. I have data files which are not .pt3 or any of the current formats, what can I do?
    You can create an issue using github and I will make the software support your file format if possible. Issues

About

License:GNU General Public License v2.0


Languages

Language:Python 99.7%Language:Cython 0.3%