OMERO.web的Python插件
项目描述
OMERO.gallery
这是一个OMERO.web插件(Django应用程序),它提供了一个“画廊”视图来查看OMERO中的图像,非常适合公共浏览而不进行编辑。
另请参阅SUPPORT.md
要求
OMERO.web 5.6.0或更高版本。
从PyPI安装
本节假定OMERO.web已经安装。
使用pip安装应用程序
$ pip install -U omero-gallery
将画廊自定义应用程序添加到您的已安装Web应用程序中
$ omero config append omero.web.apps '"omero_gallery"'
现在像平常一样重新启动OMERO.web。
OMERO.gallery概述
此应用程序支持OMERO中数据的两种替代视图,可以通过配置设置进行选择和自定义
默认UI(无配置):浏览 组 > 项目 > 数据集 > 图像
分类UI:显示感兴趣的分类。允许通过地图注释进行过滤。
对于两种视图,都可以启用公共访问如此处所述,否则用户将看到标准的Web登录屏幕。一旦登录(作为普通用户或公共用户),显示的数据将包括该用户通过正常OMERO权限可访问的所有数据。
默认UI
此视图支持浏览从组 -> 项目 -> 数据集 -> 图像层次结构所需的最小功能。此UI不支持屏幕/板/井数据。
主页将显示用户可以访问的所有可用组,每个组都有一个随机缩略图。每个组中项目、数据集和图像的数量也将显示。
浏览到组时,将显示类似布局的项目和“孤儿”数据集。
项目以每个数据集的5个缩略图显示。点击“所有图像”将加载所选数据集(或您也可以通过点击数据集名称链接浏览到数据集本身)的所有剩余缩略图。
点击缩略图将直接跳转到完整图像查看器。
分类UI
此视图最初是为IDR的使用而开发的,可以在https://idr.openmicroscopy.org/上看到。在IDR中,“研究”是项目或屏幕,并且它们通过地图注释的形式用键值数据注释,例如研究类型:3D-tracking。UI支持基于这些键值属性的几个功能
主页显示通过地图注释查询定义的“分类”。
通过地图注释过滤研究。
如果图像也通过地图注释进行注释,并且已安装https://github.com/ome/omero-mapr/,则您可以
找到包含与它们的地图注释查询匹配的图像的研究。
配置分类UI
omero.web.gallery.category_queries: 要启用分类UI,您必须设置omero.web.gallery.category_queries。如果未设置此选项,您将看到上面显示的默认UI,并且下面的其他设置将被忽略。
每个分类由一个显示标签、一个查询来选择项目和屏幕以及一个索引来指定它们在页面上的顺序定义。以下大部分示例都用于IDR。您可以在https://idr.openmicroscopy.org/上查看分类,并查看每个分类的查询,作为每个分类标签的工具提示。
在简单的情况下,如果您在研究中(项目和屏幕)没有地图注释,您可以直接按名称排序。此示例定义了一个分类:“所有研究”,以按名称显示前50个研究。
$ omero config set omero.web.gallery.category_queries '{ "all":{"label":"All Studies", "index":0, "query":"FIRST50:Name"} }'
其他分类是通过地图注释查询定义的。例如,要显示所有具有键:值为研究类型:3D-tracking的研究
$ omero config set omero.web.gallery.category_queries '{ "tracking":{"label":"3D tracking", "index":0, "query":"Study Type: 3D-tracking"} }'
查询可以使用 AND 和 OR 关键字来组合查询
$ omero config set omero.web.gallery.category_queries '{ "time":{"label":"Time-lapse imaging", "index":0, "query":"Study Type: 3D-tracking OR Study Type: time"}, "screens":{"label":"High-content screening (human)", "index":1, "query":"Organism:Homo sapiens AND Study Type:high content screen"} }'
omero.web.gallery.filter_keys: 如果此配置项被启用,则相册将允许通过与屏幕和项目相关联的键:值对进行筛选,或使用 Name 通过名称进行筛选,或使用 Group 通过组进行筛选。此列表定义了用户可以在 UI 中选择的键。选择一个键后,用户可以通过自动完成字段中输入的值进行筛选。
每个条目都是一个简单的字符串(匹配键),或者是一个具有 label 和 value 的对象,其中 value 匹配键。以下是基于 IDR 的示例
$ omero config set omero.web.gallery.filter_keys '[ "Name", "Imaging Method", "Organism", {"label": "Publication Authors", "value": "Authors"} ]'
omero.web.gallery.title: 设置相册页面的 html 页面 `<title>title</title>`
omero.web.gallery.top_left_logo: 此设置可用于用其他地方托管(png、jpeg 或 svg)的图像替换页面右上角的“OMERO”标志。它将以 33 像素的高度和最大 200 像素的宽度显示
$ omero config set omero.web.gallery.top_left_logo '{"src": "https://www.openmicroscopy.org/img/logos/ome-main-nav.svg"}'
omero.web.gallery.heading: 替换主页上的“欢迎使用 OMERO.gallery”标题。
omero.web.gallery.top_right_links: 此指定每个页面右上角的链接列表,格式为 {‘text’:’Text’,’href’:’www.url’}。如果链接包含带有更多链接的 ‘submenu’:[ ],则这些链接将在下拉菜单中显示
$ omero config set omero.web.gallery.top_right_links '[ {"text":"OME", "href":"https://www.openmicroscopy.org/"} ]'
omero.web.gallery.favicon: 设置用于浏览器的 favicon 的 URL。
omero.web.gallery.subheading_html: 设置一些 HTML 代码,在主页的 <p> 标签内显示为副标题
$ omero config set omero.web.gallery.subheading_html "This is an image gallery using <b>OMERO</b>."
omero.web.gallery.footer_html: 设置一些 HTML 代码,在每个页面上显示为页脚
$ omero config set omero.web.gallery.footer_html "<a href='https://blog.openmicroscopy.org/'>Blog</a>"
omero.web.gallery.study_short_name: 这指定了屏幕或项目在类别或搜索页面中图像上方显示的简称,而不是默认的“项目: 123”。此列表允许我们尝试多种方法,使用第一个有效的方法。列表中的每个对象例如 {‘key’: ‘Name’}。‘key’可以是名称、描述或对象上键:值对的键。如果指定了‘regex’和‘template’,我们将尝试 name.replace(regex, template)。在此示例中,我们检查名为“标题”的键:值。如果没有找到,则使用基于对象名称的正则表达式。此示例来自 IDR,我们希望从名称如: idr0001-graml-sysgro/screenA 创建一个简短的名称 idr0001A。
$ omero config set omero.web.gallery.study_short_name '[ {"key":"Title"}, {"key":"Name", "regex": "^(.*?)-.*?(.)$", "template": "$1$2"}, ]'
发布流程
审查和更新 [CHANGELOG](https://github.com/ome/omero-gallery/blob/master/CHANGELOG.md)
运行 bumpversion release 以删除 dev 后缀并创建一个签名标签
运行 bumpversion --no-tag patch 以将版本提升到下一个 dev 后缀
将新创建的标签和 master 推送到 origin。例如 git push origin master v3.3.3
Travis CI 构建标签包括 PyPI 部署步骤,因此无需手动在 PyPi 上部署
许可证
OMERO.gallery 在 AGPL 许可下发布。
版权
2016-2021,Open Microscopy Environment
项目详情
下载文件
下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。
源分发
构建分发
omero-gallery-3.4.3.tar.gz 的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 52e86bbe50091cb7afb81bd63301db31c59f3b56e3d5fffee5b30da164e362eb |
|
MD5 | 04601f41e5732df934a55689c9947888 |
|
BLAKE2b-256 | 34b53f98ff476c6a479c52a2bb6c5838d2a628792f113b5ea306030c3c9ea681 |
omero_gallery-3.4.3-py3-none-any.whl 的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | a211539e786f5253fa11aca9806fa4a1db82abba994f8e86514d1ee289f126a2 |
|
MD5 | 02f283f61788e5ba1f4fc6a70f9423eb |
|
BLAKE2b-256 | b1fbd5d356bcc8326e573d275380df4b089bb29030305372a1586fd2d599ff16 |