Generated gh-pages for commit bd43328

Author: Jens Hedegaard Nielsen <jenshnielsen@gmail.com>

    Hypothesis warnings (#905)

_modules/qcodes/data/data_set.html

@@ -557,8 +557,10 @@ <h1>Source code for qcodes.data.data_set</h1><div class="highlight"><pre>
             <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;Attempting to write&#39;</span><span class="p">)</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">()</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">last_write</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
-        <span class="k">else</span><span class="p">:</span>
-            <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;.store method: This is not the right time to write&#39;</span><span class="p">)</span>
+        <span class="c1"># The below could be useful but as it writes at every single</span>
+        <span class="c1"># step of the loop its too verbose even at debug</span>
+        <span class="c1"># else:</span>
+        <span class="c1">#     log.debug(&#39;.store method: This is not the right time to write&#39;)</span>
 
     <span class="k">def</span> <span class="nf">default_parameter_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">paramname</span><span class="o">=</span><span class="s1">&#39;amplitude&#39;</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot; Return name of default parameter for plotting</span>

_modules/qcodes/data/gnuplot_format.html

@@ -438,7 +438,10 @@ <h1>Source code for qcodes.data.gnuplot_format</h1><div class="highlight"><pre>
         <span class="c1"># Every group gets its own datafile</span>
         <span class="k">for</span> <span class="n">group</span> <span class="ow">in</span> <span class="n">groups</span><span class="p">:</span>
             <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;Attempting to write the following &#39;</span>
-                      <span class="s1">&#39;group: </span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">group</span><span class="p">))</span>
+                      <span class="s1">&#39;group: </span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">group</span><span class="o">.</span><span class="n">name</span><span class="p">))</span>
+            <span class="c1"># it might be useful to output the whole group as below but it is</span>
+            <span class="c1"># very verbose</span>
+            <span class="c1">#log.debug(&#39;containing {}&#39;.format(group))</span>
 
             <span class="k">if</span> <span class="n">filename</span><span class="p">:</span>
                 <span class="n">fn</span> <span class="o">=</span> <span class="n">io_manager</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">location</span><span class="p">,</span> <span class="n">filename</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">extension</span><span class="p">)</span>
@@ -481,7 +484,8 @@ <h1>Source code for qcodes.data.gnuplot_format</h1><div class="highlight"><pre>
 
                     <span class="n">one_point</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_data_point</span><span class="p">(</span><span class="n">group</span><span class="p">,</span> <span class="n">indices</span><span class="p">)</span>
                     <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">separator</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">one_point</span><span class="p">)</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">terminator</span><span class="p">)</span>
-                    <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;Wrote to file&#39;</span><span class="p">)</span>
+                <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;Wrote to file from &#39;</span>
+                          <span class="s1">&#39;</span><span class="si">{}</span><span class="s1"> to </span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">save_range</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">save_range</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">+</span><span class="mi">1</span><span class="p">))</span>
             <span class="c1"># now that we&#39;ve saved the data, mark it as such in the data.</span>
             <span class="c1"># we mark the data arrays and the inner setpoint array. Outer</span>
             <span class="c1"># setpoint arrays have different dimension (so would need a</span>

_modules/qcodes/loops.html

@@ -1007,8 +1007,9 @@ <h1>Source code for qcodes.loops</h1><div class="highlight"><pre>
                 <span class="n">set_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">data_set</span><span class="o">.</span><span class="n">action_id_map</span><span class="p">[</span><span class="n">action_indices</span><span class="p">]</span>
                 <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sweep_values</span><span class="p">,</span> <span class="s1">&#39;aggregate&#39;</span><span class="p">):</span>
                     <span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">sweep_values</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span><span class="o">*</span><span class="n">set_val</span><span class="p">)</span>
-                <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;Calling .store method of DataSet because &#39;</span>
-                          <span class="s1">&#39;sweep_values.parameters exist&#39;</span><span class="p">)</span>
+                <span class="c1"># below is useful but too verbose even at debug</span>
+                <span class="c1"># log.debug(&#39;Calling .store method of DataSet because &#39;</span>
+                <span class="c1">#           &#39;sweep_values.parameters exist&#39;)</span>
                 <span class="bp">self</span><span class="o">.</span><span class="n">data_set</span><span class="o">.</span><span class="n">store</span><span class="p">(</span><span class="n">new_indices</span><span class="p">,</span> <span class="p">{</span><span class="n">set_name</span><span class="p">:</span> <span class="n">value</span><span class="p">})</span>
                 <span class="c1"># set_val list of values to set [param1_setpoint, param2_setpoint ..]</span>
                 <span class="k">for</span> <span class="n">j</span><span class="p">,</span> <span class="n">val</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">set_val</span><span class="p">):</span>
@@ -1018,9 +1019,9 @@ <h1>Source code for qcodes.loops</h1><div class="highlight"><pre>
             <span class="k">else</span><span class="p">:</span>
                 <span class="n">set_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">data_set</span><span class="o">.</span><span class="n">action_id_map</span><span class="p">[</span><span class="n">action_indices</span><span class="p">]</span>
                 <span class="n">data_to_store</span><span class="p">[</span><span class="n">set_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
-
-            <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;Calling .store method of DataSet because a sweep step&#39;</span>
-                      <span class="s1">&#39; was taken&#39;</span><span class="p">)</span>
+            <span class="c1"># below is useful but too verbose even at debug</span>
+            <span class="c1"># log.debug(&#39;Calling .store method of DataSet because a sweep step&#39;</span>
+            <span class="c1">#           &#39; was taken&#39;)</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">data_set</span><span class="o">.</span><span class="n">store</span><span class="p">(</span><span class="n">new_indices</span><span class="p">,</span> <span class="n">data_to_store</span><span class="p">)</span>
 
             <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_nest_first</span><span class="p">:</span>
@@ -1029,8 +1030,9 @@ <h1>Source code for qcodes.loops</h1><div class="highlight"><pre>
 
             <span class="k">try</span><span class="p">:</span>
                 <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">callables</span><span class="p">:</span>
-                    <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;Going through callables at this sweep step.&#39;</span>
-                              <span class="s1">&#39; Calling </span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">f</span><span class="p">))</span>
+                    <span class="c1"># below is useful but too verbose even at debug</span>
+                    <span class="c1"># log.debug(&#39;Going through callables at this sweep step.&#39;</span>
+                    <span class="c1">#           &#39; Calling {}&#39;.format(f))</span>
                     <span class="n">f</span><span class="p">(</span><span class="n">first_delay</span><span class="o">=</span><span class="n">delay</span><span class="p">,</span>
                       <span class="n">loop_indices</span><span class="o">=</span><span class="n">new_indices</span><span class="p">,</span>
                       <span class="n">current_values</span><span class="o">=</span><span class="n">new_values</span><span class="p">)</span>
@@ -1068,9 +1070,9 @@ <h1>Source code for qcodes.loops</h1><div class="highlight"><pre>
             <span class="bp">self</span><span class="o">.</span><span class="n">bg_task</span><span class="p">()</span>
 
         <span class="c1"># the loop is finished - run the .then actions</span>
-        <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;Finishing loop, running the .then actions...&#39;</span><span class="p">)</span>
+        <span class="c1">#log.debug(&#39;Finishing loop, running the .then actions...&#39;)</span>
         <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_compile_actions</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">then_actions</span><span class="p">,</span> <span class="p">()):</span>
-            <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;...running .then action </span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">f</span><span class="p">))</span>
+            <span class="c1">#log.debug(&#39;...running .then action {}&#39;.format(f))</span>
             <span class="n">f</span><span class="p">()</span>
 
         <span class="c1"># run the bg_final_task from the bg_task:</span>

api/generated/qcodes.instrument_drivers.signal_hound.html

@@ -323,7 +323,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
 <dl class="attribute">
 <dt id="qcodes.instrument_drivers.signal_hound.USB_SA124B.SignalHound_USB_SA124B.saStatus_inverted">
-<code class="descname">saStatus_inverted</code><em class="property"> = {-666: 'saUnknownErr', -99: 'saFrequencyRangeErr', -95: 'saInvalidDetectorErr', -94: 'saInvalidScaleErr', -91: 'saBandwidthErr', -89: 'saExternalReferenceNotFound', -20: 'saOvenColdErr', -12: 'saInternetErr', -11: 'saUSBCommErr', -10: 'saTrackingGeneratorNotFound', -9: 'saDeviceNotIdleErr', -8: 'saDeviceNotFoundErr', -7: 'saInvalidModeErr', -6: 'saDeviceNotConfiguredErr', -5: 'saTooManyDevicesErr', -4: 'saInvalidParameterErr', -3: 'saDeviceNotOpenErr', -2: 'saInvalidDeviceErr', -1: 'saNullPtrErr', 0: 'saNoError', 1: 'saNoCorrections', 2: 'saCompressionWarning', 3: 'saParameterClamped', 4: 'saBandwidthClamped'}</em><a class="headerlink" href="#qcodes.instrument_drivers.signal_hound.USB_SA124B.SignalHound_USB_SA124B.saStatus_inverted" title="Permalink to this definition">¶</a></dt>
+<code class="descname">saStatus_inverted</code><em class="property"> = {-666: 'saUnknownErr', -99: 'saFrequencyRangeErr', -95: 'saInvalidDetectorErr', -94: 'saInvalidScaleErr', -91: 'saBandwidthErr', -89: 'saExternalReferenceNotFound', -20: 'saOvenColdErr', -12: 'saInternetErr', -11: 'saUSBCommErr', -10: 'saTrackingGeneratorNotFound', -9: 'saDeviceNotIdleErr', -8: 'saDeviceNotFoundErr', -7: 'saInvalidModeErr', -6: 'saNotConfiguredErr', -5: 'saTooManyDevicesErr', -4: 'saInvalidParameterErr', -3: 'saDeviceNotOpenErr', -2: 'saInvalidDeviceErr', -1: 'saNullPtrErr', 0: 'saNoError', 1: 'saNoCorrections', 2: 'saCompressionWarning', 3: 'saParameterClamped', 4: 'saBandwidthClamped'}</em><a class="headerlink" href="#qcodes.instrument_drivers.signal_hound.USB_SA124B.SignalHound_USB_SA124B.saStatus_inverted" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
 <dl class="method">