Metadata-Version: 2.4
Name: pyrtz2
Version: 1.4.4
Summary: Automated analysis of AFM force curves and images via Python.
Project-URL: documentation, https://www.youtube.com/@hoseynamiri
Project-URL: repository, https://github.com/HoseynAAmiri/pyrtz2
Project-URL: homepage, https://github.com/HoseynAAmiri
Author-email: "Hoseyn A. Amiri" <aamirihoseyn@gmail.com>
License: MIT License
        
        Copyright (c) 2024 Hoseyn Amiri
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Requires-Python: >=3.11
Requires-Dist: dash-bootstrap-components==1.6.0
Requires-Dist: dash==2.17.1
Requires-Dist: igor2>=0.5.9
Requires-Dist: kaleido==0.2.1
Requires-Dist: opencv-python==4.10.0.84
Requires-Dist: pandas>=2.2.3
Requires-Dist: pypdf2==3.0.1
Requires-Dist: scikit-image==0.24
Requires-Dist: scikit-learn==1.5.0
Requires-Dist: scipy==1.14.0
Requires-Dist: tqdm>=4.67.1
Description-Content-Type: text/markdown

# pyrtz2

Automated analysis of AFM force curves and images via Python. Built upon its legacy version: https://github.com/nstone8/pyrtz

Developed at Georgia Institute of Technology

# Installation
pyrtz2 is on PyPI. Install using pip (Python version >= 3.11.1 is required)

```
pip install pyrtz2
```

Please see the example folder. To run the HTML dash app interface simply use:

```
from pyrtz2 import app
app.run()
```
You should see this interface:

![pyrtz2.app](data/example.png)

You can select the contact point interactively. It will perform fits for approach and dwell parts of the curves using Hertzian and biexponential equations. After downloading the `csv` of fits, you can download those curves in one `pdf` file. Moreover, the user can annotate cells by the semi-auto and manual cell detection control panel. The images and the processed experiment can be downloaded at the end.
