omero-figure 7.1.0

要求

• OMERO.web 5.6.0或更高版本。

从PyPI安装

本节假设OMERO.web已经安装。

使用pip安装应用程序

注意：您需要确保从安装了omero-web的python环境运行pip。根据您的安装，您可能需要用以下方式调用pip：例如：/path/to_web_venv/venv/bin/pip install ...

$ pip install -U omero-figure

将图形自定义应用程序添加到已安装的Web应用程序中

$ omero config append omero.web.apps '"omero_figure"'

在web客户端顶部显示“图形”链接

$ omero config append omero.web.ui.top_links '["Figure", "figure_index",
  {"title": "Open Figure in new tab", "target": "_blank"}]'

将“图形”添加到web客户端树上的上下文菜单的“打开方式”选项中

$ omero config append omero.web.open_with '["omero_figure", "new_figure",
  {"supported_objects":["images"], "target": "_blank", "label": "OMERO.figure"}]'

现在按正常方式重新启动OMERO.web。

启用图形导出

本节假设OMERO.server已经安装。

可以使用在OMERO.server上运行的脚本将图形导出为PDF或TIFF文件。此脚本需要上传到OMERO.server，并在OMERO.server虚拟环境中安装其依赖项。

可以使用两种替代工作流程上传脚本，都需要您具有正确的管理员权限。要找到使用pip安装的OMERO.figure位置，运行

$ pip show omero-figure

该命令将显示应用程序安装目录的绝对路径，例如~/<virtualenv_name>/lib/python3.6/site-packages。转到该目录。

选项1：连接到OMERO服务器并通过CLI上传脚本。上传时务必在正确目录中，以确保脚本带有完整路径：例如omero/figure_scripts/Figure_To_Pdf.py

$ cd omero_figure/scripts
$ omero script upload omero/figure_scripts/Figure_To_Pdf.py --official

选项2：或者，在启动OMERO.server之前，将脚本从图形安装目录/omero_figure/scripts/omero/figure_scripts/Figure_To_Pdf.py复制到OMERO.server目录path/to/OMERO.server/lib/scripts/omero/figure_scripts。然后重新启动OMERO.server。

选项3：通过OMERO Web界面上传脚本：为此，以管理员身份登录OMERO Web界面，选择脚本图标并单击“上传脚本”按钮。从您复制脚本的本地目录中选择Figure_To_Pdf.py脚本并将其上传到目录omero/figure_scripts。

现在安装脚本的依赖项

• 安装reportlab PDF Python包。需要在安装OMERO.server的虚拟环境中安装。根据您的安装，您可能需要用以下方式调用pip：例如：/path/to_server_venv/venv/bin/pip install ...

$ pip install reportlab

• 可选：可以使用Markdown语法格式化图形标题。要正确显示在导出的PDF信息页面上，我们需要Python Markdown

$ pip install markdown

升级OMERO.figure

在升级OMERO.figure后

$ pip install -U omero-figure

您需要使用上面描述的2种选项之一更新图形导出脚本。如果使用选项1，您需要替换现有脚本

# Get the ID of the existing Figure_To_Pdf script:
$ omero script list

# Replace the script
$ cd omero_figure/scripts
$ omero script replace <SCRIPT_ID> omero/figure_scripts/Figure_To_Pdf.py

开发

我们在开发期间使用vite.js构建和提供应用程序。

从https://node.org.cn安装Node，然后

$ cd omero-figure
$ npm install

使用vite开发服务器在http://localhost:8080/提供应用程序（这将自动在更改保存时刷新页面）

$ npm run start

如果您正在编辑Shape-Editor代码，您可以在http://localhost:8080/shapeEditorTest.html查看测试页面

构建

要构建应用程序

$ npm run build

此操作将编译 index.html 和其他静态资源到正确的位置，以便由 Django omero-web 服务器提供服务。

为了在本地 omero-web 上提供服务，设置配置如下，并使用以下命令安装

$ pip install -e .

为了在 src/ 目录中的更改保存时自动构建

$ npm run watch

发布流程

此存储库使用 bump2version 管理版本号。要标记发布，请运行

$ bumpversion release

这将从当前版本中删除 .dev0 后缀，提交并标记发布。

要切换回开发版本，请运行以下命令

$ bumpversion --no-tag [major|minor|patch]

指定 major，minor 或 patch，具体取决于开发分支将是一个 major，minor 或 patch 发布。这将也会添加 .dev0 后缀。

请记住，使用 git push 推送所有提交和标签。

许可

OMERO.figure 在 AGPL 许可下发布。

版权

2016-2024，Open Microscopy Environment