Commit 018c8571 authored by Christoph Sommer's avatar Christoph Sommer
Browse files

initial README documentation

parent 4e187729
......@@ -5,12 +5,38 @@ in Gerganova et al. https://www.biorxiv.org/content/10.1101/2020.12.18.423457v3
## Example
## Installation
### 1. GUI
Open a command-line shell and type.
`frapdiff`
### 2. Command-line interface
Open a command-line shell and type.
`frapdiff -h`
### 3. Jupyter notebook
#### pip
```python
from frapdiff import frapdiff
result_dict = frapdiff.extract_frap_profiles_and_fit(
movie_fn,
bleach_correction=True,
roi_ext_factor=1.5,
project_on='v',
mirror='first_half',
D_guess=0.05,
koff_guess=0.1,
min_l_f=8,
max_l_f=16,
correction_region_size=150,
)
```
## Installation
### pip
pip install git+https://git.ist.ac.at/csommer/frapdiff
#### Dependencies
numpy, pandas, tifffile, roifile, Gooey, wxPython
### Dependencies (automatically installed via pip)
numpy, pandas, tifffile, roifile, Gooey, wxPython, scipy, matplotlib
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment