From cef4203d6e02876de9e8eb57ccf4176cf968adac Mon Sep 17 00:00:00 2001 From: Laurent Guerard Date: Thu, 27 Mar 2025 16:10:48 +0100 Subject: [PATCH 1/2] Update documentation for OMERO tools requirements Clarify that both `simple-omero-client` and `omero-insight` JARs are required for functionality. Add links for better reference. --- src/imcflibs/imagej/omerotools.py | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/src/imcflibs/imagej/omerotools.py b/src/imcflibs/imagej/omerotools.py index 2e2c4325..a7143947 100644 --- a/src/imcflibs/imagej/omerotools.py +++ b/src/imcflibs/imagej/omerotools.py @@ -3,9 +3,16 @@ Contains helpers to parse URLs and / or OMERO image IDs, connect to OMERO and fetch images from the server. -Requires the [`simple-omero-client`][simple-omero-client] JAR to be installed. +Requires both the [`simple-omero-client`][simple-omero-client] and the +[`omero-insight`][omero-insight] JARs to be installed. -[simple-omero-client]: https://github.com/GReD-Clermont/simple-omero-client +Most of the functions will use the [`simple-omero-client`][simple-omero-client] +to interact with the OMERO server. However, there are still some that +requires the [`omero-insight`][omero-insight] plugin to read metadata. + +[simple-omero-client]: +https://github.com/GReD-Clermont/simple-omero-client +[omero]: https://github.com/ome/omero-insight """ from fr.igred.omero import Client From 5cba0260909da1ae29c04f84e4ddc7bd8fa7e0f0 Mon Sep 17 00:00:00 2001 From: Laurent Guerard Date: Thu, 27 Mar 2025 16:14:30 +0100 Subject: [PATCH 2/2] Fix formatting of references in omerotools.py documentation --- src/imcflibs/imagej/omerotools.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/src/imcflibs/imagej/omerotools.py b/src/imcflibs/imagej/omerotools.py index a7143947..1534f137 100644 --- a/src/imcflibs/imagej/omerotools.py +++ b/src/imcflibs/imagej/omerotools.py @@ -10,9 +10,8 @@ to interact with the OMERO server. However, there are still some that requires the [`omero-insight`][omero-insight] plugin to read metadata. -[simple-omero-client]: -https://github.com/GReD-Clermont/simple-omero-client -[omero]: https://github.com/ome/omero-insight +[simple-omero-client]: https://github.com/GReD-Clermont/simple-omero-client +[omero-insight]: https://github.com/ome/omero-insight """ from fr.igred.omero import Client