OMERO.web的Python插件
项目描述
IDR gallery
这是一个OMERO.web插件(Django应用),它提供了OMERO中图像的“画廊”视图,非常适合公开浏览而不进行编辑。
另请参阅 SUPPORT.md
需求
OMERO.web 5.6.0或更高版本。
从PyPI安装
本节假设OMERO.web已经安装。
使用pip安装应用
$ pip install -U idr-gallery
将画廊自定义应用添加到已安装的Web应用中
$ omero config append omero.web.apps '"idr_gallery"'
现在像往常一样重新启动OMERO.web。
IDR.gallery概述
此UI是为IDR的使用而开发的,可以在https://idr.openmicroscopy.org/中看到。在IDR中,“研究”是项目或筛选,它们通过Map Annotations形式的键值数据进行了注释,例如 Study Type: 3D-tracking。该UI支持基于这些键值属性的多项功能
主页显示由Map Annotations查询定义的“类别”。
通过Map Annotations过滤研究。
如果图像也通过Map Annotations进行了注释,并且已安装https://github.com/ome/omero-mapr/,则可以
找到包含与它们的Map Annotations查询匹配的图像的研究。
配置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"} }'
其他分类通过地图注释的查询定义。例如,要显示所有具有 Study Type: 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中选择哪些键。选择键后,用户将能够通过自动完成字段中输入的值进行筛选。
每个项是一个简单的字符串(匹配键)或一个具有 标签 和 值 的对象,其中 值 匹配键。以下是一个基于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)的图像替换页面右上角的“IDR”标志。它将以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: 替换主页上的“欢迎来到IDR.gallery”标题。
omero.web.gallery.top_right_links: 这指定了每个页面右上角的链接列表,格式为 {‘text’:’Text’,’href’:’www.url’}。如果链接包含‘submenu’:[ ]具有更多链接,则这些链接将在下拉菜单中显示
$ omero config set omero.web.gallery.top_right_links '[ {"text":"IDR", "href":"https://idr.openmicroscopy.org/"} ]'
omero.web.gallery.favicon: 设置用于浏览器的favicon的URL。
omero.web.gallery.study_short_name: 此指定显示在分类或搜索页面中的屏幕或项目上方的短名称,而不是默认的“项目:123”。此列表允许我们尝试多种方法,使用第一个有效的方法。列表中的每个对象都具有例如 {‘key’: ‘Name’}。‘key’可以是名称、描述或对象上的键:值对的键。如果指定了‘regex’和‘template’,我们将尝试 name.replace(regex, template)。在此示例中,我们检查名为“标题”的键:值。如果找不到,则使用基于对象名称的正则表达式。此示例来自IDR,我们希望从名称创建一个短名称,例如 idr0001A,从名称: idr0001-graml-sysgro/screenA
$ omero config set omero.web.gallery.study_short_name '[ {"key":"Title"}, {"key":"Name", "regex": "^(.*?)-.*?(.)$", "template": "$1$2"}, ]'
发布过程
偶尔更新 loadStudyStats() 中的 totalImages 和其他回退计数
审查和更新 CHANGELOG
运行 bumpversion release 以删除开发后缀并创建签名标签
运行 bumpversion --no-tag patch 以将版本提升到下一个开发后缀
将新创建的标签和 master 推送到 origin。例如: git push origin master v3.3.3
GitHub 动作的构建步骤包括 PyPI 部署步骤,因此不需要在 PyPI 上手动部署
许可证
idr_gallery 根据 AGPL 发布。
版权
2016-2023,开放显微镜环境
项目详情
下载文件
下载适用于您平台的文件。如果您不确定选择哪一个,请了解更多关于 安装包 的信息。
源分发
构建分发
idr-gallery-3.11.0.tar.gz 的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 00934477f451c4e5568bd41a1cd4f0e644a02436e0d140bdd3dfd3e3a9b8be97 |
|
MD5 | a4fb4475a4161282c0f639009fe8c366 |
|
BLAKE2b-256 | aba943f23e95087c758382670f6a489eea5b556a5b3f87bb56f9a1b207c4088d |
idr_gallery-3.11.0-py3-none-any.whl 的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 925e3c6cef6ea9caaf225e40c98726d3b8154f5fc38ba89a737964fc3dc6d8f7 |
|
MD5 | 61a19b7df54680d79898be5c4c2c8414 |
|
BLAKE2b-256 | d1a3f20bd0639d82daee7d8835e6a140231e588f26c3caa103d918aa1dd59166 |