Skip to main content

OMERO webtagging tagsearch app

Project description

https://github.com/German-BioImaging/omero-tagsearch/workflows/PyPI/badge.svg https://badge.fury.io/py/omero-tagsearch.svg

OMERO.tagsearch

OMERO.tagsearch is a plugin for OMERO.web that enables searching of data using tags, with the search continuously refined as available search terms are entered and further term suggestions based on the entered terms are offered. This can be used in a way that is similar to navigating a file system hierarchy.

This was formerly part of OMERO.webtagging, the umbrella name for tools developed to enhance use of text annotations (tags) in OMERO.

Requirements

As Python 2 has now reached end-of-life, OMERO 5.6 now requires Python 3. With release 3.1.0 of tagsearch, the following are now required. To use tagsearch on older OMERO systems (running Python 2), please use versions older than 3.1.0.

  • Python 3.8 or later

  • omero-web 5.6 or later

  • django 4.2 or later

User Documentation

http://help.openmicroscopy.org/web-tagging.html

Installation

The recommended way to install tagsearch is using pip, but it is also possible to install it manually as described here.

# In the python environment of OMERO.web (virtualenv or global)
pip install omero-tagsearch

# Add tagsearch to webclient
omero config append omero.web.apps '"omero_tagsearch"'

# Add a top-link to tagsearch designer
omero config append omero.web.ui.top_links '["Tag Search", "tagsearch"]'

Upgrade from omero-webtagging-tagsearch to omero-tagsearch

Since 3.2.2, the package was renamed to omero-tagsearch. This is a breaking change for OMERO.web, as the old package must be removed from the OMERO.web config and replaced by the new package.

You can perform the upgrade as follow:

# stop omero web
# Install the new package and uninstall the old one
pip uninstall omero-webtagging-tagsearch
pip install omero-tagsearch

# Then open the OMERO.web configuration editor
omero config edit
# Update the configuration called 'omero.web.apps'
# In 'omero.web.apps': 'omero_webtagging_tagsearch' -> 'omero_tagsearch'
# start omero web

Note that installing the latest omero-webtagging-autotag is not functional but has a dependency on omero-autotag. Thus, if you wish to use the old version omero-webtagging-tagsearch, make sure to specify the latest working version:

# ONLY IF YOU WANT TO USE AN OLDER VERSION OF THE PLUGIN
# stop omero web
pip install omero-webtagging-tagsearch==3.2.0
# And set the configuration accordingly
# start omero web

Documentation

Available on the OMERO website.

Development

Pure javascript so does not require a node build step.

To install using pip in development mode (in appropriate virtualenv)

::

# In the top-level tagsearch directory containing setup.py pip install -e . cd $OMERO_PREFIX

OMERO development server can then be started in the usual way. Remember to configure the tagsearch settings the same as above.

Project Maintenance

I (Douglas) am no longer actively developing OMERO.webtagging. I am thrilled to hand over maintainence and development to German Bioimaging.

Acknowledgements

OMERO.webtagging was created by Douglas P. W. Russell (dpwrussell@gmail.com) while at Oxford University and Harvard Medical School, then later extended by DPWR Consulting Ltd.

These plugins were developed originally with the support of Micron Advanced Bioimaging Unit funded by the Wellcome Trust Strategic Award 091911, and Open Microscopy.

Continued development was supported by The Laboratory of Systems Pharmacology, Harvard Medical School and Research Computing, Harvard Medical School.

Continued development was sponsored by Micron Advanced Bioimaging Unit funded by the Wellcome Trust Strategic Award 107457.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

omero-tagsearch-4.2.0.tar.gz (122.7 kB view details)

Uploaded Source

Built Distribution

omero_tagsearch-4.2.0-py3-none-any.whl (132.0 kB view details)

Uploaded Python 3

File details

Details for the file omero-tagsearch-4.2.0.tar.gz.

File metadata

  • Download URL: omero-tagsearch-4.2.0.tar.gz
  • Upload date:
  • Size: 122.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.8.19

File hashes

Hashes for omero-tagsearch-4.2.0.tar.gz
Algorithm Hash digest
SHA256 5a49c48ae4a4df1510ae446034dbc32425108e4c1b8de32ac6d1157224e90eab
MD5 2d0bab7e86f85314ee816b1e463a4ecb
BLAKE2b-256 e9c41d12399317a18ebc6b72a768bf41ed960933403ae27bb9603798d4a60180

See more details on using hashes here.

Provenance

File details

Details for the file omero_tagsearch-4.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for omero_tagsearch-4.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ffef26b07d397912a3522458882758d867698da619091e4fa26e50c071055ebf
MD5 e352a5aed14dbd9b9ff51703f1829bc3
BLAKE2b-256 d627e1933d6287994a741a5339d48b0149e0a576252e750451dc478dceac3478

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page