Skip to content

Commit

Permalink
Generated gh-pages for commit cf556fb
Browse files Browse the repository at this point in the history
Author: Jens Hedegaard Nielsen <jenshnielsen@gmail.com>

    Snapshot update may fail for array parameters and such (#717)
  • Loading branch information
Documentation Bot committed Aug 30, 2017
1 parent 03fe65b commit 28a1121
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 12 deletions.
6 changes: 5 additions & 1 deletion _modules/qcodes/instrument/base.html
Expand Up @@ -326,7 +326,11 @@ <h1>Source code for qcodes.instrument.base</h1><div class="highlight"><pre>
<span class="n">update</span> <span class="o">=</span> <span class="n">update</span>
<span class="k">if</span> <span class="n">params_to_skip_update</span> <span class="ow">and</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">params_to_skip_update</span><span class="p">:</span>
<span class="n">update</span> <span class="o">=</span> <span class="kc">False</span>
<span class="n">snap</span><span class="p">[</span><span class="s1">&#39;parameters&#39;</span><span class="p">][</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">param</span><span class="o">.</span><span class="n">snapshot</span><span class="p">(</span><span class="n">update</span><span class="o">=</span><span class="n">update</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">snap</span><span class="p">[</span><span class="s1">&#39;parameters&#39;</span><span class="p">][</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">param</span><span class="o">.</span><span class="n">snapshot</span><span class="p">(</span><span class="n">update</span><span class="o">=</span><span class="n">update</span><span class="p">)</span>
<span class="k">except</span><span class="p">:</span>
<span class="n">logging</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Snapshot: Could not update parameter: </span><span class="si">{}</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">name</span><span class="p">))</span>
<span class="n">snap</span><span class="p">[</span><span class="s1">&#39;parameters&#39;</span><span class="p">][</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">param</span><span class="o">.</span><span class="n">snapshot</span><span class="p">(</span><span class="n">update</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="k">for</span> <span class="n">attr</span> <span class="ow">in</span> <span class="nb">set</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_meta_attrs</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="p">,</span> <span class="n">attr</span><span class="p">):</span>
<span class="n">snap</span><span class="p">[</span><span class="n">attr</span><span class="p">]</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">attr</span><span class="p">)</span>
Expand Down
10 changes: 5 additions & 5 deletions api/generated/qcodes.instrument_drivers.american_magnetics.html
Expand Up @@ -248,8 +248,8 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/string.html#module-string" title="(in Python v3.5)"><em>string</em></a>) – a name for the instrument</li>
<li><strong>magnet_x</strong> (<a class="reference internal" href="#module-qcodes.instrument_drivers.american_magnetics.AMI430" title="qcodes.instrument_drivers.american_magnetics.AMI430"><em>AMI430</em></a>) – magnet for the x component</li>
<li><strong>magnet_y</strong> (<a class="reference internal" href="#module-qcodes.instrument_drivers.american_magnetics.AMI430" title="qcodes.instrument_drivers.american_magnetics.AMI430"><em>AMI430</em></a>) – magnet for the y component</li>
<li><strong>magnet_x</strong> (<a class="reference internal" href="#qcodes.instrument_drivers.american_magnetics.AMI430.AMI430" title="qcodes.instrument_drivers.american_magnetics.AMI430.AMI430"><em>AMI430</em></a>) – magnet for the x component</li>
<li><strong>magnet_y</strong> (<a class="reference internal" href="#qcodes.instrument_drivers.american_magnetics.AMI430.AMI430" title="qcodes.instrument_drivers.american_magnetics.AMI430.AMI430"><em>AMI430</em></a>) – magnet for the y component</li>
</ul>
</td>
</tr>
Expand Down Expand Up @@ -295,9 +295,9 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/string.html#module-string" title="(in Python v3.5)"><em>string</em></a>) – a name for the instrument</li>
<li><strong>magnet_x</strong> (<a class="reference internal" href="#module-qcodes.instrument_drivers.american_magnetics.AMI430" title="qcodes.instrument_drivers.american_magnetics.AMI430"><em>AMI430</em></a>) – magnet driver for the x component</li>
<li><strong>magnet_y</strong> (<a class="reference internal" href="#module-qcodes.instrument_drivers.american_magnetics.AMI430" title="qcodes.instrument_drivers.american_magnetics.AMI430"><em>AMI430</em></a>) – magnet driver for the y component</li>
<li><strong>magnet_z</strong> (<a class="reference internal" href="#module-qcodes.instrument_drivers.american_magnetics.AMI430" title="qcodes.instrument_drivers.american_magnetics.AMI430"><em>AMI430</em></a>) – magnet driver for the z component</li>
<li><strong>magnet_x</strong> (<a class="reference internal" href="#qcodes.instrument_drivers.american_magnetics.AMI430.AMI430" title="qcodes.instrument_drivers.american_magnetics.AMI430.AMI430"><em>AMI430</em></a>) – magnet driver for the x component</li>
<li><strong>magnet_y</strong> (<a class="reference internal" href="#qcodes.instrument_drivers.american_magnetics.AMI430.AMI430" title="qcodes.instrument_drivers.american_magnetics.AMI430.AMI430"><em>AMI430</em></a>) – magnet driver for the y component</li>
<li><strong>magnet_z</strong> (<a class="reference internal" href="#qcodes.instrument_drivers.american_magnetics.AMI430.AMI430" title="qcodes.instrument_drivers.american_magnetics.AMI430.AMI430"><em>AMI430</em></a>) – magnet driver for the z component</li>
</ul>
</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion api/generated/qcodes.instrument_drivers.ithaco.html
Expand Up @@ -225,7 +225,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>measured_param</strong> (<a class="reference internal" href="qcodes.Parameter.html#qcodes.Parameter" title="qcodes.Parameter"><em>Parameter</em></a>) – a gettable parameter returning the
voltage read from the Ithaco output.</li>
<li><strong>c_amp_ins</strong> (<a class="reference internal" href="#module-qcodes.instrument_drivers.ithaco.Ithaco_1211" title="qcodes.instrument_drivers.ithaco.Ithaco_1211"><em>Ithaco_1211</em></a>) – <p>an Ithaco instance where you manually
<li><strong>c_amp_ins</strong> (<a class="reference internal" href="#qcodes.instrument_drivers.ithaco.Ithaco_1211.Ithaco_1211" title="qcodes.instrument_drivers.ithaco.Ithaco_1211.Ithaco_1211"><em>Ithaco_1211</em></a>) – <p>an Ithaco instance where you manually
maintain the present settings of the real Ithaco amp.</p>
<p>Note: it should be possible to use other current preamps, if they
define parameters <code class="docutils literal"><span class="pre">sens</span></code> (sensitivity, in A/V), <code class="docutils literal"><span class="pre">sens_factor</span></code>
Expand Down
4 changes: 2 additions & 2 deletions api/generated/qcodes.instrument_drivers.signal_hound.html
Expand Up @@ -319,12 +319,12 @@ <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">
<code class="descname">saStatus</code><em class="property"> = {'saUnknownErr': -666, 'saDeviceNotOpenErr': -3, 'saNoCorrections': 1, 'saOvenColdErr': -20, 'saDeviceNotFoundErr': -8, 'saNotConfiguredErr': -6, 'saDeviceNotIdleErr': -9, 'saInvalidModeErr': -7, 'saBandwidthClamped': 4, 'saParameterClamped': 3, 'saExternalReferenceNotFound': -89, 'saInternetErr': -12, 'saInvalidDetectorErr': -95, 'saInvalidScaleErr': -94, 'saFrequencyRangeErr': -99, 'saTooManyDevicesErr': -5, 'saTrackingGeneratorNotFound': -10, 'saInvalidParameterErr': -4, 'saNullPtrErr': -1, 'saCompressionWarning': 2, 'saNoError': 0, 'saDeviceNotConfiguredErr': -6, 'saBandwidthErr': -91, 'saInvalidDeviceErr': -2, 'saUSBCommErr': -11}</em><a class="headerlink" href="#qcodes.instrument_drivers.signal_hound.USB_SA124B.SignalHound_USB_SA124B.saStatus" title="Permalink to this definition"></a></dt>
<code class="descname">saStatus</code><em class="property"> = {'saExternalReferenceNotFound': -89, 'saInternetErr': -12, 'saOvenColdErr': -20, 'saNotConfiguredErr': -6, 'saBandwidthErr': -91, 'saParameterClamped': 3, 'saUnknownErr': -666, 'saDeviceNotOpenErr': -3, 'saNoCorrections': 1, 'saInvalidDeviceErr': -2, 'saCompressionWarning': 2, 'saDeviceNotIdleErr': -9, 'saBandwidthClamped': 4, 'saInvalidModeErr': -7, 'saUSBCommErr': -11, 'saInvalidDetectorErr': -95, 'saInvalidParameterErr': -4, 'saInvalidScaleErr': -94, 'saDeviceNotConfiguredErr': -6, 'saNullPtrErr': -1, 'saFrequencyRangeErr': -99, 'saNoError': 0, 'saTrackingGeneratorNotFound': -10, 'saTooManyDevicesErr': -5, 'saDeviceNotFoundErr': -8}</em><a class="headerlink" href="#qcodes.instrument_drivers.signal_hound.USB_SA124B.SignalHound_USB_SA124B.saStatus" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<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"> = {0: 'saNoError', 1: 'saNoCorrections', 2: 'saCompressionWarning', 3: 'saParameterClamped', 4: 'saBandwidthClamped', -99: 'saFrequencyRangeErr', -95: 'saInvalidDetectorErr', -94: 'saInvalidScaleErr', -91: 'saBandwidthErr', -666: 'saUnknownErr', -89: 'saExternalReferenceNotFound', -20: 'saOvenColdErr', -12: 'saInternetErr', -2: 'saInvalidDeviceErr', -10: 'saTrackingGeneratorNotFound', -9: 'saDeviceNotIdleErr', -8: 'saDeviceNotFoundErr', -7: 'saInvalidModeErr', -6: 'saDeviceNotConfiguredErr', -5: 'saTooManyDevicesErr', -4: 'saInvalidParameterErr', -3: 'saDeviceNotOpenErr', -1: 'saNullPtrErr', -11: 'saUSBCommErr'}</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"> = {0: 'saNoError', 1: 'saNoCorrections', 2: 'saCompressionWarning', 3: 'saParameterClamped', 4: 'saBandwidthClamped', -2: 'saInvalidDeviceErr', -99: 'saFrequencyRangeErr', -95: 'saInvalidDetectorErr', -94: 'saInvalidScaleErr', -91: 'saBandwidthErr', -666: 'saUnknownErr', -89: 'saExternalReferenceNotFound', -20: 'saOvenColdErr', -12: 'saInternetErr', -11: 'saUSBCommErr', -10: 'saTrackingGeneratorNotFound', -9: 'saDeviceNotIdleErr', -8: 'saDeviceNotFoundErr', -7: 'saInvalidModeErr', -6: 'saDeviceNotConfiguredErr', -5: 'saTooManyDevicesErr', -4: 'saInvalidParameterErr', -3: 'saDeviceNotOpenErr', -1: 'saNullPtrErr'}</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">
Expand Down
Expand Up @@ -514,7 +514,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>measured_param</strong> (<a class="reference internal" href="qcodes.Parameter.html#qcodes.Parameter" title="qcodes.Parameter"><em>Parameter</em></a>) – a gettable parameter returning the
voltage read from the SR560 output.</li>
<li><strong>v_amp_ins</strong> (<a class="reference internal" href="#qcodes.instrument_drivers.stanford_research.SR560.SR560" title="qcodes.instrument_drivers.stanford_research.SR560.SR560"><em>SR560</em></a>) – <p>an SR560 instance where you manually
<li><strong>v_amp_ins</strong> (<a class="reference internal" href="#module-qcodes.instrument_drivers.stanford_research.SR560" title="qcodes.instrument_drivers.stanford_research.SR560"><em>SR560</em></a>) – <p>an SR560 instance where you manually
maintain the present settings of the real SR560 amp.</p>
<p>Note: it should be possible to use other voltage preamps, if they
define parameters <code class="docutils literal"><span class="pre">gain</span></code> (V_out / V_in) and <code class="docutils literal"><span class="pre">invert</span></code>
Expand Down
4 changes: 2 additions & 2 deletions api/generated/qcodes.instrument_drivers.tektronix.html
Expand Up @@ -267,12 +267,12 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
</table>
<dl class="attribute">
<dt id="qcodes.instrument_drivers.tektronix.AWG5014.Tektronix_AWG5014.AWG_FILE_FORMAT_CHANNEL">
<code class="descname">AWG_FILE_FORMAT_CHANNEL</code><em class="property"> = {'DIGITAL_METHOD_N': 'h', 'MARKER1_OFFSET_N': 'd', 'ANALOG_FILTER_N': 'h', 'MARKER1_LOW_N': 'd', 'PHASE_DELAY_INPUT_METHOD_N': 'h', 'DIGITAL_LOW_N': 'd', 'OUTPUT_WAVEFORM_NAME_N': 's', 'MARKER1_SKEW_N': 'd', 'CHANNEL_STATE_N': 'h', 'ANALOG_HIGH_N': 'd', 'CHANNEL_SKEW_N': 'd', 'ANALOG_LOW_N': 'd', 'MARKER1_METHOD_N': 'h', 'PHASE_N': 'd', 'ANALOG_METHOD_N': 'h', 'MARKER2_OFFSET_N': 'd', 'ANALOG_AMPLITUDE_N': 'd', 'MARKER2_SKEW_N': 'd', 'MARKER2_HIGH_N': 'd', 'DELAY_IN_TIME_N': 'd', 'EXTERNAL_ADD_N': 'h', 'ANALOG_DIRECT_OUTPUT_N': 'h', 'MARKER1_AMPLITUDE_N': 'd', 'MARKER1_HIGH_N': 'd', 'DC_OUTPUT_LEVEL_N': 'd', 'MARKER2_LOW_N': 'd', 'DIGITAL_HIGH_N': 'd', 'MARKER2_AMPLITUDE_N': 'd', 'DIGITAL_AMPLITUDE_N': 'd', 'ANALOG_OFFSET_N': 'd', 'MARKER2_METHOD_N': 'h', 'DELAY_IN_POINTS_N': 'd', 'DIGITAL_OFFSET_N': 'd'}</em><a class="headerlink" href="#qcodes.instrument_drivers.tektronix.AWG5014.Tektronix_AWG5014.AWG_FILE_FORMAT_CHANNEL" title="Permalink to this definition"></a></dt>
<code class="descname">AWG_FILE_FORMAT_CHANNEL</code><em class="property"> = {'MARKER1_METHOD_N': 'h', 'PHASE_DELAY_INPUT_METHOD_N': 'h', 'MARKER2_METHOD_N': 'h', 'MARKER2_LOW_N': 'd', 'OUTPUT_WAVEFORM_NAME_N': 's', 'DIGITAL_METHOD_N': 'h', 'MARKER1_OFFSET_N': 'd', 'MARKER1_AMPLITUDE_N': 'd', 'ANALOG_AMPLITUDE_N': 'd', 'MARKER2_SKEW_N': 'd', 'DELAY_IN_POINTS_N': 'd', 'ANALOG_METHOD_N': 'h', 'DIGITAL_AMPLITUDE_N': 'd', 'DC_OUTPUT_LEVEL_N': 'd', 'EXTERNAL_ADD_N': 'h', 'ANALOG_FILTER_N': 'h', 'CHANNEL_SKEW_N': 'd', 'DIGITAL_OFFSET_N': 'd', 'CHANNEL_STATE_N': 'h', 'MARKER2_AMPLITUDE_N': 'd', 'ANALOG_OFFSET_N': 'd', 'MARKER1_SKEW_N': 'd', 'MARKER2_OFFSET_N': 'd', 'ANALOG_LOW_N': 'd', 'DIGITAL_HIGH_N': 'd', 'ANALOG_HIGH_N': 'd', 'DIGITAL_LOW_N': 'd', 'ANALOG_DIRECT_OUTPUT_N': 'h', 'DELAY_IN_TIME_N': 'd', 'MARKER2_HIGH_N': 'd', 'PHASE_N': 'd', 'MARKER1_HIGH_N': 'd', 'MARKER1_LOW_N': 'd'}</em><a class="headerlink" href="#qcodes.instrument_drivers.tektronix.AWG5014.Tektronix_AWG5014.AWG_FILE_FORMAT_CHANNEL" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="qcodes.instrument_drivers.tektronix.AWG5014.Tektronix_AWG5014.AWG_FILE_FORMAT_HEAD">
<code class="descname">AWG_FILE_FORMAT_HEAD</code><em class="property"> = {'REPETITION_RATE': 'd', 'EXTERNAL_REFERENCE_TYPE': 'h', 'REFERENCE_SOURCE': 'h', 'TRIGGER_SOURCE': 'h', 'TRIGGER_INPUT_POLARITY': 'h', 'CLOCK_SOURCE': 'h', 'SAMPLING_RATE': 'd', 'RUN_STATE': 'h', 'INTERLEAVE_ADJ_PHASE': 'd', 'WAIT_VALUE': 'h', 'INTERNAL_TRIGGER_RATE': 'd', 'JUMP_TIMING': 'h', 'HOLD_REPETITION_RATE': 'h', 'REFERENCE_MULTIPLIER_RATE': 'h', 'EVENT_INPUT_POLARITY': 'h', 'INTERLEAVE_ADJ_AMPLITUDE': 'd', 'INTERLEAVE': 'h', 'RUN_MODE': 'h', 'REFERENCE_CLOCK_FREQUENCY_SELECTION': 'h', 'ZEROING': 'h', 'DIVIDER_RATE': 'h', 'TRIGGER_INPUT_IMPEDANCE': 'h', 'COUPLING': 'h', 'EVENT_INPUT_THRESHOLD': 'd', 'TRIGGER_INPUT_THRESHOLD': 'd', 'TRIGGER_INPUT_SLOPE': 'h', 'EVENT_INPUT_IMPEDANCE': 'h'}</em><a class="headerlink" href="#qcodes.instrument_drivers.tektronix.AWG5014.Tektronix_AWG5014.AWG_FILE_FORMAT_HEAD" title="Permalink to this definition"></a></dt>
<code class="descname">AWG_FILE_FORMAT_HEAD</code><em class="property"> = {'HOLD_REPETITION_RATE': 'h', 'TRIGGER_INPUT_IMPEDANCE': 'h', 'SAMPLING_RATE': 'd', 'CLOCK_SOURCE': 'h', 'JUMP_TIMING': 'h', 'RUN_STATE': 'h', 'COUPLING': 'h', 'REFERENCE_MULTIPLIER_RATE': 'h', 'EXTERNAL_REFERENCE_TYPE': 'h', 'TRIGGER_INPUT_SLOPE': 'h', 'WAIT_VALUE': 'h', 'EVENT_INPUT_POLARITY': 'h', 'INTERNAL_TRIGGER_RATE': 'd', 'EVENT_INPUT_THRESHOLD': 'd', 'REPETITION_RATE': 'd', 'EVENT_INPUT_IMPEDANCE': 'h', 'INTERLEAVE_ADJ_PHASE': 'd', 'TRIGGER_SOURCE': 'h', 'REFERENCE_SOURCE': 'h', 'DIVIDER_RATE': 'h', 'REFERENCE_CLOCK_FREQUENCY_SELECTION': 'h', 'RUN_MODE': 'h', 'TRIGGER_INPUT_THRESHOLD': 'd', 'ZEROING': 'h', 'INTERLEAVE_ADJ_AMPLITUDE': 'd', 'INTERLEAVE': 'h', 'TRIGGER_INPUT_POLARITY': 'h'}</em><a class="headerlink" href="#qcodes.instrument_drivers.tektronix.AWG5014.Tektronix_AWG5014.AWG_FILE_FORMAT_HEAD" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="method">
Expand Down

0 comments on commit 28a1121

Please sign in to comment.