Qmix泵和阀门接口

此Python包使用CFFI包装了Cetoni Qmix泵和阀门接口DLL。支持Python 2和3。

目录表

• 快速安装说明
• 甘特表设置
• 通过pyqmix-web操作泵 (无需安装)
• 安装Python和pyqmix
• 通过pyqmix操作泵 (需要安装)
• 最佳实践
• 引用

快速安装说明

如果您已经安装了Cetoni QmixSDK，通过QmixElements创建了一个设备配置，并且熟悉Python，您可以通过conda从conda-forge安装pyqmix。要为pyqmix创建一个新的名为nemesys的conda环境，请运行

conda create -n nemesys -c conda-forge pyqmix

从命令行进行。这是推荐的安装程序，因为它确保安装 pyqmix 及其所有依赖项不会更改任何现有的 conda 环境。

要将 pyqmix 安装到现有的 conda 环境中，请运行

conda install -c conda-forge pyqmix

然而，我们建议您始终创建一个全新的、专用的环境。

当然，您也可以通过老式的 pip 安装 pyqmix

pip install pyqmix

如果您对此一无所知，我们建议您按照下面描述的步骤进行。

甘特表设置

找到光盘和许可证代码

打开您从 CETONI 收到的文档夹。在文档夹中，您将找到一个许可证密钥和包含

• 软件：QmixElements 和 QmixSDK 的光盘
• QmixElements 手册在 Doc/Software 中，其中指定了系统要求以及如何安装软件

准备您的计算机

按照文档中的说明设置计算机上的系统要求。参考 QmixElements 手册

• 禁用待机或休眠模式
• 在控制面板的电源选项中禁用 USB 端口的省电模式

安装 QmixElements

• 将 CETONI 的光盘插入您的计算机。
• 以管理员身份启动 QmixElements_Setup_v###.exe 应用程序文件
• 在安装过程中，接受安装 VCI (VCI 驱动器)
• 如果收到 Windows 安全警告 -> 信任来自 HMS Technology Center Ravensburg GmbH 的软件。

安装 QmixSDK

• 安装您从 CETONI 的光盘上收到的 QmixSDK。pyqmix 已测试与 QmixSDK 版本 20180626 及更高版本兼容。如果您的 QmixSDK 版本低于该版本，请联系 Cetoni 获取更新的版本。
• 重新启动计算机

将泵系统连接到计算机

• 将基础模块连接到计算机
• 将电源连接到基础模块
• 使用提供的 USB 线缆将基础模块连接到计算机。

创建设备配置

• 打开 QmixElements
• 激活许可证
  • 编辑 -> 激活许可证 -> [输入许可证密钥] -> 点击确定。许可证密钥可在 CETONI 提供的文件夹中的光盘上找到。
• 创建实际的设备配置
  • 设备 -> 创建配置 -> 然后您将被询问：您是否希望用新版本更新本地设备数据库 devices.db？。如果您在 CETONI 安装光盘上有 devices.db 文件，则单击 是 按钮，并浏览该文件。
    从设备列表中将所有要配置的项目拖动到 QmixElements 软件左侧的大空白黑色区域“设备配置”中。您不需要配置基础模块。
• 保存配置
  • 文件 -> 保存。
• 右键单击设备配置中的第一个项目（最左侧的一个），选择“配置”并按照说明操作。对设备配置中的每个项目重复此过程。
• 最后保存配置。

通过 pyqmix-web 操作泵

pyqmix-web 的用户界面部分在网页浏览器中运行。您需要一个现代浏览器来运行应用程序。Chrome、Firefox 和 Safari 的最新版本运行良好；Microsoft Internet Explorer 不受支持。

• 从 https://github.com/psyfood/pyqmix-web/releases 下载最新的 pyqmix-web 发布版本（您需要获取 .exe 文件）。
• 运行 .exe 文件

安装Python和pyqmix

安装 Anaconda Python

• 如果尚未安装，请安装 Anaconda Python 发行版。您可以从 https://anaconda.net.cn/download/ 下载它。获取 "Python 3.x" 版本。
• 在设置过程中，跳过安装 Microsoft VSCode
• 否则，只需接受默认设置即可

创建一个新的 Python 环境

创建一个新的名为nemesys的conda Python环境，并将所需的软件包安装到该环境中。

• 点击Windows按钮或打开“开始”菜单
• 打开Anaconda Prompt。这将打开一个命令行窗口，该窗口已正确设置以使用您的Anaconda Python安装。
• 创建nemesys Python环境，并安装pyqmix以及Spyder开发环境
  • 输入：conda create -n nemesys python=3 pyqmix spyder

通过pyqmix操作泵

打开和运行脚本

• 如上所述打开Anaconda Prompt。
• 激活nemesys环境
  • 输入：activate nemesys
• 启动Spyder开发环境
  • 输入：spyder
• 打开示例脚本，运行并修改它们。
• 祝您玩得开心！

最佳实践

泵系统的设置和最佳实践在我们的论文中有描述（见下文引用）。此外，我们建议以下程序以提高可靠性和易用性

• 确保输出管长度相等，以确保所有泵的刺激开始时间相同。
• 确保管子切割干净且直，垂直于管子。这可以通过使用所谓的管子切割器来实现。
• 50 mL的玻璃注射器与注射器支架配合非常紧密。特别是当新的时，可能需要相对用力才能将注射器实际插入支架。随着时间的推移，这会变得容易，因为注射器和支架会“磨合”。
• 如果施加过多压力，玻璃注射器可能会破裂。请确保使用注射器支架和注射器活塞支架将注射器牢固地固定，但不要过度拧紧注射器支架，以免压碎注射器玻璃筒。
• 移除气泡。我们开发了一种新程序，该程序已集成到pyqmix-web中，并将引导用户完成此过程。

引用

如果您使用本软件，请引用我们的出版物

Andersen, Camilla Arndal, Alfine, Lorenzo, Ohla, Kathrin, & Höchenberger, Richard. (待发表). 一种新的味觉计：构建便携式和模块化刺激器的模板。 行为研究方法。doi: 10.3758/s13428-018-1145-1

可以从Zenodo获取预印本。

版本2021.1.2

• 2021.1中引入的DLL搜索改进现在也适用于Python 3.6和3.7。

版本2021.1

• 改进了自动DLL搜索路径配置；现在在更多情况下应该可以“开箱即用”地加载DLL，包括在运行Python 3.8和更新的系统上。
• 改回使用pywin32而不是pypiwin32。

版本2019.1

• 处理不存在的配置目录

版本2018.12.13

• 更新安装说明
• 现在Travis自动化测试也适用于Python 2.7（之前仅测试Python 3）
• switch_valve_when_done关键字参数现在对所有泵操作都可用
• 依赖于pypiwin32而不是pywin32

版本2018.11.07

• 当从轮安装时，报告正确的版本号

版本2018.11.05

• 更新文档
• 处理用户请求删除不存在配置文件的情况
• 更新软件包要求，包括pywin32。
• 我们现在为Python 2和3构建通用的wheels。
• 添加对GitHub上Travis持续集成测试的支持。

版本2018.10.08a

• 与版本2018.10.08功能相同，但为config模块添加了额外的docstrings。

版本2018.10.08

本发行版包括以下所有更改。

2018-10-06

• 假设Qmix配置文件的默认位置（以避免完整路径）。

2018-10-04

• 将switch_valve_when_finished关键字参数重命名为switch_valve_when_done，以匹配wait_until_done措辞
• 将 switch_valve_when_finished 关键字参数添加到 QmixPump.aspirate() 方法中。
• 在使用 wait_until_done 关键字参数时，等待泵实际开始工作后再检查泵是否完成抽吸。
• 当指定 switch_valve_when_done=True 关键字参数时，隐含 wait_until_done=True。
• 改进 Qmix SDK DLL 的自动发现。

2018-09-13

• 将 blocking_wait 关键字参数重命名为 wait_until_done。

2018-08-09

• 添加 QmixPump.fill() 和 empty() 方法。
• QmixPump 方法现在会在无效的体积和流速参数上引发错误。
• 将包规范从 setup.py 移动到 setup.cfg。
• 修复确定有效阀门位置时的错误。

2018-08-07

• 修复 reathedocs 构建。

2018-08-02

• 将 config 模块添加到 pyqmix.__all__ 中。
• 移除 Qmix SDK 头文件目录配置选项。
• 添加方便的方法 QmixPump.set_syringe_params_by_type()，通过指定注射器类型来设置注射器参数。
• 实例化 QmixPump 时设置默认的流速和体积单位。

2018-08-01

• 支持最新的 Qmix SDK。
• 默认情况下不恢复泵驱动位置计数器。
• 添加方便的方法 QmixPump.set_syringe_params_by_type()，通过指定注射器类型来设置注射器参数。

2018-05-25

• 支持配置文件。
• 默认情况下在调整泵时不要进行阻塞等待。
• 更多示例脚本。
• 添加对几个新 Qmix SDK 函数的支持。

2018-02-21

• QmixBus 获得了 auto_open 和 auto_start 初始化参数。
• QmixPump 获得了 auto_enable 初始化参数。

2017-10-09

• 将 config.py 模块转换为子包。
• 将泵配置添加到新的 config.pumps 模块中。
• 添加 pump.init_pump() 方便函数用于泵设置。
• 添加 pump.fill_syringes() 和 pump.empty_syringes 方便函数。

2017-10-05

• 添加 config.py 模块。

2017-10-04

• 添加阀门 position 设置器。新的属性替换了 QmixValve 和 QmixExternalValve 的 current_position 属性。
• 将单体 interface.py 分割为设备特定的子模块。