wright-plans

一组Bluesky计划，专注于Wright组内的实验编排。

安装

从PyPI安装最新发布的版本

$ python3 -m pip install wright-plans

conda-forge即将推出！

使用flit从源安装。

$ git clone https://github.com/wright-group/wright-plans.git
$ cd wright-plans
$ flit install -s

用法

wright-plans在三个主要方面扩展了Bluesky

• 支持WrightTools风格的单位
• 支持“常量”，如下所述的硬件关系的代数表达式
• 支持Wright组实验的独特专用调整程序

此包中定义的计划都以_wp结尾，以确保它们的名称永远不会与Bluesky本身或其他Bluesky计划提供者中定义的计划冲突。如果合适，请随意将这些计划混合到现有环境中。有关如何在简单的Python脚本或笔记本环境中利用这些计划的文档，请参阅Bluesky文档。以下是一个最小示例

>>> import yaqc_bluesky
>>> motor1 = yaqc_bluesky.Device(39000)
>>> motor2 = yaqc_bluesky.Device(39001)
>>> sensor = yaqc_bluesky.Device(39002)
>>> import bluesky
>>> RE = bluesky.RunEngine()
>>> import wright_plans
>>> RE(wright_plans.grid_scan_wp([sensor], motor1, -1, 1, 11, "mm", motor2, -1, 1, 11, "mm")

对于在bluesky-queueserver中的使用，请考虑bluesky-in-a-box。

请注意，这些计划生成的运行通过from_databroker方法保证与WrightTools兼容。

>>> import databroker
>>> import WrightTools as wt
>>> mongo = databroker.catalog["mongo"]
>>> run = mongo[-1]  # get most recent run from catalog
>>> wt.data.from_databroker(mongo)
<WrightTools.Data>

来自更广泛的BlueSky生态系统的计划可能与from_databroker兼容，也可能不兼容。BlueSky具有任意编排的能力，某些实验违反了WrightTools的核心假设。然而，BlueSky数据处理的其余生态系统仍适用于此类计划。

常量

常量提供了一种使用与扫描硬件位置相关的代数表达式驱动辅助硬件的工具。

例如，涉及两个可调光源w1和w2的扫描可能使单色仪(wm)跟踪代数和2 * w1 + w2。这对于《Neff-Mallon和Wright 2017》中描述的相干多维光谱学特别重要。

wright_plans中的常量允许对其他硬件进行任意线性组合，这些硬件具有兼容的单位。常量具有单位意识，并在指定单位中进行加法和乘法。

常量使用Constant类和ConstantTerm元素定义。

上述扫描的示例

>>> import yaqc_bluesky
>>> w1 = yaqc_bluesky.Device(39000)
>>> w2 = yaqc_bluesky.Device(39001)
>>> wm = yaqc_bluesky.Device(39002)
>>> sensor = yaqc_bluesky.Device(39003)
>>>
>>> import bluesky
>>> RE = bluesky.RunEngine()
>>>
>>> from wright_plans import Constant, ConstantTerm, gridscan_wp
>>> constants = {wm: Constant("wn", [
...     ConstantTerm(2, w1),
...     ConstantTerm(1, w2),
... ])}
>>> RE(grid_scan_wp([sensor], motor1, -1, 1, 11, "mm", motor2, -1, 1, 11, "mm", constants=constants)

常量字典中的每个条目描述了一个可移动设备的跟踪行为，多个设备可以通过将字典作为参数传递（例如{motor1: constant1, motor2: constant2}）在单个扫描中设置跟踪。

计划

Wright计划提供了以下计划，可以通过它们的文档字符串找到计划签名