Metadata-Version: 2.1
Name: optiflow
Version: 1.0.0
Summary: Reconstruction of flows from kymographs with optimal transport
Home-page: https://github.com/sacha-ichbiah/optiflow
Author: Sacha Ichbiah
Author-email: sacha.ichbiah@college-de-france.fr
Project-URL: Team website, https://www.turlierlab.com/
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Science/Research
Requires-Python: <3.10,>=3.6
Description-Content-Type: text/markdown

# Optiflow
<img src="Images/optiflow_logo.png" alt="drawing" width="500"/>

**optiflow** is an algorithm design to reconstruct **velocity fields** from **kymographs** with **optimal transport**. Indeed, optimal transport gives the velocity field of minimal work, which is relevant under a wide array of situations and does not necessitates hard physical assumptions, except for the conservation of the physical quantity that we are measuring across time.
This software is designed to offer cell biologists a simple method to obtain these flow fields, that are notably hard to measure.


---
## Example
<img src="Images/optiflow_example.png" alt="drawing" width="500"/>
An example is provided in the jupyter notebook Optiflow_presentation.ipynb
---

---
## Installation
To install the package 

`python -m pip install`
---

**optiflow** was created by Sacha Ichbiah during his PhD in [Turlier Lab](https://www.turlierlab.com), during a collaboration with Henry de Belly, with the lab of [Orion Weiner](https://weinerlab.com), and is maintained by Sacha Ichbiah and Hervé Turlier. For support, please open an issue.
A preprint of the paper using this method will be published soon. If you use our library in your work please cite the paper.


