Skip to content

Commit

Permalink
deploy: bluesky/ophyd@e9f51dd
Browse files Browse the repository at this point in the history
  • Loading branch information
@mrakitin
mrakitin committed Jul 16, 2024
1 parent b5bf2e3 commit c3127a3
Show file tree
Hide file tree
Showing 9 changed files with 46 additions and 45 deletions.
Binary file modified ophyd/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified ophyd/.doctrees/user/tutorials/device.doctree
View file
Binary file not shown.
Binary file modified ophyd/.doctrees/user/tutorials/single-PV.doctree
View file
Binary file not shown.
Binary file modified ophyd/objects.inv
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion ophyd/searchindex.js
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion ophyd/user/explanations/status.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -770,7 +770,7 @@ <h2>Partial Progress Updates<a class="headerlink" href="#partial-progress-update
<p>Some Status objects provide an additional method named <code class="docutils literal notranslate"><span class="pre">watch</span></code>, as in
<code class="xref py py-meth docutils literal notranslate"><span class="pre">watch()</span></code>, which can be used to subscribe to
<em>incremental</em> progress updates suitable for building progress bars. See
<a class="reference external" href="https://blueskyproject.io/bluesky/main/progress-bar.html" title="(in bluesky v1.13.0a4.dev258+gb844d49a)"><span>Progress Bar</span></a> for one application of this feature.</p>
<a class="reference external" href="https://blueskyproject.io/bluesky/main/progress-bar.html" title="(in bluesky v1.13.0a4.dev261+g5bd9a415)"><span>Progress Bar</span></a> for one application of this feature.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">watch</span></code> method accepts a callback which must accept the following
parameters as optional keyword arguments:</p>
<ul class="simple">
Expand Down
2 changes: 1 addition & 1 deletion ophyd/user/reference/core.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -638,7 +638,7 @@ <h2>Callbacks<a class="headerlink" href="#callbacks" title="Permalink to this he
<p>This registry is used to connect to the underlying events from the
control system and propagate them up to bluesky, either via
<code class="xref py py-class docutils literal notranslate"><span class="pre">StatusBase</span></code> objects or via direct subscription from the
<a class="reference external" href="https://blueskyproject.io/bluesky/main/generated/bluesky.run_engine.RunEngine.html#bluesky.run_engine.RunEngine" title="(in bluesky v1.13.0a4.dev258+gb844d49a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">RunEngine</span></code></a>.</p>
<a class="reference external" href="https://blueskyproject.io/bluesky/main/generated/bluesky.run_engine.RunEngine.html#bluesky.run_engine.RunEngine" title="(in bluesky v1.13.0a4.dev261+g5bd9a415)"><code class="xref py py-class docutils literal notranslate"><span class="pre">RunEngine</span></code></a>.</p>
</section>
</section>

Expand Down
29 changes: 15 additions & 14 deletions ophyd/user/tutorials/device.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -667,14 +667,14 @@ <h2>Use it with the Bluesky RunEngine<a class="headerlink" href="#use-it-with-th
<span class="go">+-----------+------------+---------------------+</span>
<span class="go">| seq_num | time | random_walk_horiz_x |</span>
<span class="go">+-----------+------------+---------------------+</span>
<span class="go">| 1 | 21:00:39.7 | 1 |</span>
<span class="go">| 2 | 21:00:40.7 | 1 |</span>
<span class="go">| 3 | 21:00:41.7 | 1 |</span>
<span class="go">| 1 | 14:13:53.9 | 0 |</span>
<span class="go">| 2 | 14:13:54.9 | 0 |</span>
<span class="go">| 3 | 14:13:55.9 | 0 |</span>
<span class="go">+-----------+------------+---------------------+</span>
<span class="go">generator count [&#39;db860e80&#39;] (scan num: 1)</span>
<span class="go">generator count [&#39;aca01165&#39;] (scan num: 1)</span>


<span class="gh">Out[14]: </span><span class="go">(&#39;db860e80-342b-4a78-9669-b670d49ba1f1&#39;,)</span>
<span class="gh">Out[14]: </span><span class="go">(&#39;aca01165-94fa-4bcc-97bb-499530dd6d23&#39;,)</span>
</pre></div>
</div>
<p>We can also read <code class="docutils literal notranslate"><span class="pre">random_walk_horiz</span></code> in its entirety as a unit, treating it as
Expand All @@ -685,14 +685,14 @@ <h2>Use it with the Bluesky RunEngine<a class="headerlink" href="#use-it-with-th
<span class="go">+-----------+------------+---------------------+----------------------+</span>
<span class="go">| seq_num | time | random_walk_horiz_x | random_walk_horiz_dt |</span>
<span class="go">+-----------+------------+---------------------+----------------------+</span>
<span class="go">| 1 | 21:00:42.9 | 1 | 3 |</span>
<span class="go">| 2 | 21:00:43.9 | 1 | 3 |</span>
<span class="go">| 3 | 21:00:44.9 | 1 | 3 |</span>
<span class="go">| 1 | 14:13:57.0 | 0 | 3 |</span>
<span class="go">| 2 | 14:13:58.0 | -0 | 3 |</span>
<span class="go">| 3 | 14:13:59.0 | -0 | 3 |</span>
<span class="go">+-----------+------------+---------------------+----------------------+</span>
<span class="go">generator count [&#39;57184582&#39;] (scan num: 2)</span>
<span class="go">generator count [&#39;e7b2ad2d&#39;] (scan num: 2)</span>


<span class="gh">Out[15]: </span><span class="go">(&#39;57184582-3770-430a-bb6f-324d6601c188&#39;,)</span>
<span class="gh">Out[15]: </span><span class="go">(&#39;e7b2ad2d-17d4-4c8f-866c-789c32e92172&#39;,)</span>
</pre></div>
</div>
</section>
Expand All @@ -704,9 +704,9 @@ <h2>Assign a “Kind” to Components<a class="headerlink" href="#assign-a-kind-
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="gp">In [16]: </span><span class="n">random_walk_horiz</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
<span class="gh">Out[16]: </span>
<span class="go">OrderedDict([(&#39;random_walk_horiz_x&#39;,</span>
<span class="go"> {&#39;value&#39;: 0.9388836852176359, &#39;timestamp&#39;: 1720213243.646966}),</span>
<span class="go"> {&#39;value&#39;: -0.20491920786137818, &#39;timestamp&#39;: 1721139237.828844}),</span>
<span class="go"> (&#39;random_walk_horiz_dt&#39;,</span>
<span class="go"> {&#39;value&#39;: 3.0, &#39;timestamp&#39;: 1720213237.625821})])</span>
<span class="go"> {&#39;value&#39;: 3.0, &#39;timestamp&#39;: 1721139231.806909})])</span>
</pre></div>
</div>
<p>This is probably not necessary. Unless we have some reason to expect that it
Expand Down Expand Up @@ -738,12 +738,13 @@ <h2>Assign a “Kind” to Components<a class="headerlink" href="#assign-a-kind-
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="gp">In [21]: </span><span class="n">random_walk_horiz</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
<span class="gh">Out[21]: </span>
<span class="go">OrderedDict([(&#39;random_walk_horiz_x&#39;,</span>
<span class="go"> {&#39;value&#39;: 0.9388836852176359, &#39;timestamp&#39;: 1720213243.646966})])</span>
<span class="go"> {&#39;value&#39;: -0.20491920786137818,</span>
<span class="go"> &#39;timestamp&#39;: 1721139237.828844})])</span>

<span class="gp">In [22]: </span><span class="n">random_walk_horiz</span><span class="o">.</span><span class="n">read_configuration</span><span class="p">()</span>
<span class="gh">Out[22]: </span>
<span class="go">OrderedDict([(&#39;random_walk_horiz_dt&#39;,</span>
<span class="go"> {&#39;value&#39;: 3.0, &#39;timestamp&#39;: 1720213237.625821})])</span>
<span class="go"> {&#39;value&#39;: 3.0, &#39;timestamp&#39;: 1721139231.806909})])</span>
</pre></div>
</div>
<div class="admonition note">
Expand Down
56 changes: 28 additions & 28 deletions ophyd/user/tutorials/single-PV.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -650,28 +650,28 @@ <h2>Use it with the Bluesky RunEngine<a class="headerlink" href="#use-it-with-th
<span class="go">+-----------+------------+------------+</span>
<span class="go">| seq_num | time | time_delta |</span>
<span class="go">+-----------+------------+------------+</span>
<span class="go">| 1 | 21:00:47.1 | 3 |</span>
<span class="go">| 1 | 14:14:01.3 | 3 |</span>
<span class="go">+-----------+------------+------------+</span>
<span class="go">generator count [&#39;f6296352&#39;] (scan num: 1)</span>
<span class="go">generator count [&#39;94bbabe4&#39;] (scan num: 1)</span>


<span class="gh">Out[10]: </span><span class="go">(&#39;f6296352-8664-4676-babd-cc73cbf564be&#39;,)</span>
<span class="gh">Out[10]: </span><span class="go">(&#39;94bbabe4-a422-42d8-8bdf-c47625d26e2e&#39;,)</span>

<span class="gp">In [11]: </span><span class="n">RE</span><span class="p">(</span><span class="n">list_scan</span><span class="p">([],</span> <span class="n">time_delta</span><span class="p">,</span> <span class="p">[</span><span class="mf">0.1</span><span class="p">,</span> <span class="mf">0.3</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">]))</span> <span class="c1"># Use as &quot;motor&quot;.</span>


<span class="go">+-----------+------------+------------+</span>
<span class="go">| seq_num | time | time_delta |</span>
<span class="go">+-----------+------------+------------+</span>
<span class="go">| 1 | 21:00:47.2 | 0 |</span>
<span class="go">| 2 | 21:00:47.2 | 0 |</span>
<span class="go">| 3 | 21:00:47.2 | 1 |</span>
<span class="go">| 4 | 21:00:47.2 | 3 |</span>
<span class="go">| 1 | 14:14:01.4 | 0 |</span>
<span class="go">| 2 | 14:14:01.4 | 0 |</span>
<span class="go">| 3 | 14:14:01.4 | 1 |</span>
<span class="go">| 4 | 14:14:01.4 | 3 |</span>
<span class="go">+-----------+------------+------------+</span>
<span class="go">generator list_scan [&#39;2b2f4eb0&#39;] (scan num: 2)</span>
<span class="go">generator list_scan [&#39;c3b13191&#39;] (scan num: 2)</span>


<span class="gh">Out[11]: </span><span class="go">(&#39;2b2f4eb0-9104-4bf9-988c-32313832a156&#39;,)</span>
<span class="gh">Out[11]: </span><span class="go">(&#39;c3b13191-c1c9-4ebd-ac0b-664731bef960&#39;,)</span>
</pre></div>
</div>
<p>For the following example, set <code class="docutils literal notranslate"><span class="pre">time_delta</span></code> to <code class="docutils literal notranslate"><span class="pre">1</span></code>.</p>
Expand All @@ -689,16 +689,16 @@ <h2>Use it with the Bluesky RunEngine<a class="headerlink" href="#use-it-with-th
<span class="go">+-----------+------------+------------+------------+</span>
<span class="go">| seq_num | time | time_delta | x |</span>
<span class="go">+-----------+------------+------------+------------+</span>
<span class="go">| 1 | 21:00:47.3 | | 1 |</span>
<span class="go">| 2 | 21:00:47.8 | | 1 |</span>
<span class="go">| 3 | 21:00:48.3 | | 1 |</span>
<span class="go">| 4 | 21:00:48.8 | | 1 |</span>
<span class="go">| 5 | 21:00:49.3 | | 1 |</span>
<span class="go">| 1 | 14:14:01.5 | | 0 |</span>
<span class="go">| 2 | 14:14:02.0 | | 0 |</span>
<span class="go">| 3 | 14:14:02.5 | | 0 |</span>
<span class="go">| 4 | 14:14:03.0 | | 0 |</span>
<span class="go">| 5 | 14:14:03.5 | | 1 |</span>
<span class="go">+-----------+------------+------------+------------+</span>
<span class="go">generator count [&#39;048f0878&#39;] (scan num: 3)</span>
<span class="go">generator count [&#39;6a096131&#39;] (scan num: 3)</span>


<span class="gh">Out[14]: </span><span class="go">(&#39;048f0878-2457-40d2-bc42-0b5f609b44bc&#39;,)</span>
<span class="gh">Out[14]: </span><span class="go">(&#39;6a096131-1bb1-418c-89e8-cf01998e9ef7&#39;,)</span>
</pre></div>
</div>
<p>but this required us to choose an update frequency (<code class="docutils literal notranslate"><span class="pre">0.5</span></code>). It’s often better
Expand All @@ -723,16 +723,16 @@ <h2>Use it with the Bluesky RunEngine<a class="headerlink" href="#use-it-with-th
<span class="go">+-----------+------------+------------+</span>
<span class="go">| seq_num | time | x |</span>
<span class="go">+-----------+------------+------------+</span>
<span class="go">| 1 | 21:00:50.0 | 1 |</span>
<span class="go">| 2 | 21:00:50.0 | 1 |</span>
<span class="go">| 3 | 21:00:50.2 | 1 |</span>
<span class="go">| 4 | 21:00:51.2 | 2 |</span>
<span class="go">| 5 | 21:00:52.2 | 2 |</span>
<span class="go">| 1 | 14:14:04.2 | 1 |</span>
<span class="go">| 2 | 14:14:04.2 | 1 |</span>
<span class="go">| 3 | 14:14:04.4 | 1 |</span>
<span class="go">| 4 | 14:14:05.4 | 2 |</span>
<span class="go">| 5 | 14:14:06.4 | 2 |</span>
<span class="go">+-----------+------------+------------+</span>
<span class="go">generator monitor_x_for [&#39;b8429e3f&#39;] (scan num: 4)</span>
<span class="go">generator monitor_x_for [&#39;4f4f391a&#39;] (scan num: 4)</span>


<span class="gh">Out[18]: </span><span class="go">(&#39;b8429e3f-fc9a-42ae-b6b4-29763310588d&#39;,)</span>
<span class="gh">Out[18]: </span><span class="go">(&#39;4f4f391a-489e-4627-85d2-1c291e3a0566&#39;,)</span>
</pre></div>
</div>
<p>If you are a scientist aiming to use Ophyd with the Bluesky Run Engine, you may
Expand All @@ -754,7 +754,7 @@ <h3>Read<a class="headerlink" href="#read" title="Permalink to this heading">#</
containing the <code class="docutils literal notranslate"><span class="pre">value</span></code> and the <code class="docutils literal notranslate"><span class="pre">timestamp</span></code> of the reading from the control
system (in this case, EPICS).</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="gp">In [19]: </span><span class="n">time_delta</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
<span class="gh">Out[19]: </span><span class="go">{&#39;time_delta&#39;: {&#39;value&#39;: 1.0, &#39;timestamp&#39;: 1720213247.385331}}</span>
<span class="gh">Out[19]: </span><span class="go">{&#39;time_delta&#39;: {&#39;value&#39;: 1.0, &#39;timestamp&#39;: 1721139241.56594}}</span>
</pre></div>
</div>
</section>
Expand Down Expand Up @@ -861,10 +861,10 @@ <h3>Subscribe<a class="headerlink" href="#subscribe" title="Permalink to this he
items in it.</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="gp">In [30]: </span><span class="n">readings</span>
<span class="gh">Out[30]: </span>
<span class="go">deque([{&#39;x&#39;: {&#39;value&#39;: 2.301118882534819, &#39;timestamp&#39;: 1720213252.286116}},</span>
<span class="go"> {&#39;x&#39;: {&#39;value&#39;: 2.601648523698085, &#39;timestamp&#39;: 1720213253.287426}},</span>
<span class="go"> {&#39;x&#39;: {&#39;value&#39;: 1.9871399415416278, &#39;timestamp&#39;: 1720213254.288615}},</span>
<span class="go"> {&#39;x&#39;: {&#39;value&#39;: 1.1266770872623417, &#39;timestamp&#39;: 1720213255.290561}}],</span>
<span class="go">deque([{&#39;x&#39;: {&#39;value&#39;: 1.618234220056903, &#39;timestamp&#39;: 1721139246.475534}},</span>
<span class="go"> {&#39;x&#39;: {&#39;value&#39;: 1.965905681123027, &#39;timestamp&#39;: 1721139247.477592}},</span>
<span class="go"> {&#39;x&#39;: {&#39;value&#39;: 2.7725605678051175, &#39;timestamp&#39;: 1721139248.479039}},</span>
<span class="go"> {&#39;x&#39;: {&#39;value&#39;: 3.333429827466321, &#39;timestamp&#39;: 1721139249.481}}],</span>
<span class="go"> maxlen=5)</span>
</pre></div>
</div>
Expand Down

0 comments on commit c3127a3

Please sign in to comment.