From fae6faea501f74c47013eabb974240cf4736168e Mon Sep 17 00:00:00 2001 From: Pete Date: Tue, 29 Oct 2024 11:20:03 +0000 Subject: [PATCH] Add missing formatting/links (#21) Co-authored-by: Alan O'Callaghan --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 56a2834..dca8b8b 100644 --- a/README.md +++ b/README.md @@ -8,28 +8,28 @@ The name comes from **Quantitative Bioimage Analysis Laboratory**. This is chose QuBaLab isn't QuPath - they're just good friends. -* **QuPath** is a user-friendly Java application for bioimage analysis, which has some especially nice features for handling whole slide and highly-multiplexed images. But lots of bioimage analysis research is done in Python, and is hard to integrate with QuPath. +* **QuPath** is a user-friendly Java application for bioimage analysis, which has some especially nice features for handling whole slide and highly-multiplexed images. But lots of bioimage analysis research is done in Python, and is hard to integrate with QuPath. * **QuBaLab**'s main aim is to help with this, by providing tools to help exchange data between QuPath and Python *without any direct dependency on QuPath and Java*. It therefore doesn't require QuPath to be installed, and can be used entirely from Python. QuBaLab doesn't share code with QuPath, but is uses many of the same conventions for accessing images and representing objects in a GeoJSON compatible way. By using the same custom fields for things like measurements and classifications, exchanging data is much easier. ### How does QuBaLab compare to paquo? -paquo is an existing library linking Python and QuPath that provides a pythonic interface to QuPath. +[paquo](https://paquo.readthedocs.io/) is an existing library linking Python and QuPath that provides a pythonic interface to QuPath. -We think paquo is great, and don't want to replace it! +_We think paquo is great - we don't want to replace it!_ Here are the 3 main differences as we see them: -1. Target audience - - paquo is written mostly for Python programmers who need to work with QuPath data - - QuBaLab is written mostly for QuPath users who want to dip into Python -2. Convenience vs. Efficiency - - paquo is based on JPype to provide full & efficient access to Java from Python - - QuBaLab is based on Py4J to exchange data between Java & Python - preferring convenience over efficiency -3. Pixel access - - paquo is for working with QuPath projects and objects - accessing pixels is beyond its scope (at least for now) - - QuBaLab enables requesting pixels as numpy or dask arrays, and provides functions to convert between thresholded images & QuPath objects +1. **Target audience** + - paquo is written mostly for Python programmers who need to work with QuPath data + - QuBaLab is written mostly for QuPath users who want to dip into Python +2. **Convenience vs. Efficiency** + - paquo is based on [JPype](http://jpype.readthedocs.io/) to provide full & efficient access to Java from Python + - QuBaLab is based on [Py4J](https://www.py4j.org) to exchange data between Java & Python - preferring convenience to efficiency +3. **Pixel access** + - paquo is for working with QuPath projects and objects - accessing pixels is beyond its scope (at least for now) + - QuBaLab enables requesting pixels as numpy or dask arrays, and provides functions to convert between thresholded images & QuPath objects So if you're a Python programmer who needs an intuitive and efficient way to work with QuPath data, use paquo.