Metadata-Version: 2.1
Name: pybioprox
Version: 1.0.1
Summary: Distance-based colocalisation analysis module
Home-page: https://github.com/PyBioProx/PyBioProx
Author: Jeremy Metz
Author-email: j.metz@exeter.ac.uk
License: AGPLv3
Platform: UNKNOWN
Requires-Python: >=3.4
Description-Content-Type: text/markdown
Requires-Dist: imageio (>=2.6.1)
Requires-Dist: scipy (>=1.4.1)
Requires-Dist: scikit-image (>=0.16.2)
Requires-Dist: colorama (>=0.4.3)
Requires-Dist: coloredlogs (>=14.0)
Requires-Dist: pandas (>=1.0.3)
Requires-Dist: numpy (>=1.18)
Requires-Dist: tifffile (>=2020.2.16)
Requires-Dist: matplotlib (>=3.2.1)
Provides-Extra: dev
Requires-Dist: coverage (>=5.2) ; extra == 'dev'
Requires-Dist: PyQt5 ; extra == 'dev'
Requires-Dist: pytest-qt ; extra == 'dev'
Provides-Extra: gui
Requires-Dist: PyQt5 ; extra == 'gui'

# PyBioProx: 2 & 3d spatial distance analysis in Python

This module, `pybioprox`, offers efficient 2d and 3d spatial analysis of colocalisation. 
The analyses fall into the category of object-based colocalisation methods. 

## Installation 

To install this Python module, you may use pip as follows: 

```
    pip install PyBioProx
```

If you wish to also install the optional Graphical User Interface script, this may be done 
by specifying the `gui` optional extra: 

```
    pip install PyBioProx[gui]
```


## Getting started

Once installed, the module can be invoked from the command-line using: 

```
    python -m pybioprox <path_to_folder> 
```

to run the analysis in batch mode on all data files at the location `path_to_folder`. 

If you have installed the gui component, then you may also run 
```
    pybioprox_gui.py
```
directly from the command line. 


