Skip to content

Commit cef4203

Browse files
committed
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.
1 parent 7cc70a6 commit cef4203

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

src/imcflibs/imagej/omerotools.py

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,16 @@
33
Contains helpers to parse URLs and / or OMERO image IDs, connect to OMERO and
44
fetch images from the server.
55
6-
Requires the [`simple-omero-client`][simple-omero-client] JAR to be installed.
6+
Requires both the [`simple-omero-client`][simple-omero-client] and the
7+
[`omero-insight`][omero-insight] JARs to be installed.
78
8-
[simple-omero-client]: https://github.com/GReD-Clermont/simple-omero-client
9+
Most of the functions will use the [`simple-omero-client`][simple-omero-client]
10+
to interact with the OMERO server. However, there are still some that
11+
requires the [`omero-insight`][omero-insight] plugin to read metadata.
12+
13+
[simple-omero-client]:
14+
https://github.com/GReD-Clermont/simple-omero-client
15+
[omero]: https://github.com/ome/omero-insight
916
"""
1017

1118
from fr.igred.omero import Client

0 commit comments

Comments
 (0)