Skip to content

Commit

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

    Fix: awg5014 missing units (#514)
  • Loading branch information
Documentation Bot committed Mar 16, 2017
1 parent c437a97 commit a58b316
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion api/generated/qcodes.instrument_drivers.ithaco.html
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,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>) &#8211; a gettable parameter returning the
voltage read from the Ithaco output.</li>
<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>) &#8211; <p>an Ithaco instance where you manually
<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>) &#8211; <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
Original file line number Diff line number Diff line change
Expand Up @@ -311,12 +311,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"> = {'saNotConfiguredErr': -6, 'saBandwidthClamped': 4, 'saNoError': 0, 'saTrackingGeneratorNotFound': -10, 'saOvenColdErr': -20, 'saInvalidParameterErr': -4, 'saBandwidthErr': -91, 'saInternetErr': -12, 'saUSBCommErr': -11, 'saInvalidDeviceErr': -2, 'saInvalidModeErr': -7, 'saDeviceNotFoundErr': -8, 'saNullPtrErr': -1, 'saTooManyDevicesErr': -5, 'saNoCorrections': 1, 'saDeviceNotConfiguredErr': -6, 'saExternalReferenceNotFound': -89, 'saUnknownErr': -666, 'saDeviceNotOpenErr': -3, 'saInvalidDetectorErr': -95, 'saParameterClamped': 3, 'saInvalidScaleErr': -94, 'saDeviceNotIdleErr': -9, 'saCompressionWarning': 2, 'saFrequencyRangeErr': -99}</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"> = {'saNullPtrErr': -1, 'saDeviceNotFoundErr': -8, 'saExternalReferenceNotFound': -89, 'saOvenColdErr': -20, 'saNoCorrections': 1, 'saNoError': 0, 'saDeviceNotIdleErr': -9, 'saInvalidParameterErr': -4, 'saFrequencyRangeErr': -99, 'saInvalidDetectorErr': -95, 'saTrackingGeneratorNotFound': -10, 'saInternetErr': -12, 'saDeviceNotOpenErr': -3, 'saNotConfiguredErr': -6, 'saBandwidthClamped': 4, 'saDeviceNotConfiguredErr': -6, 'saInvalidModeErr': -7, 'saBandwidthErr': -91, 'saInvalidDeviceErr': -2, 'saCompressionWarning': 2, 'saUSBCommErr': -11, 'saTooManyDevicesErr': -5, 'saUnknownErr': -666, 'saInvalidScaleErr': -94, 'saParameterClamped': 3}</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', -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>
<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', -1: 'saNullPtrErr', -10: 'saTrackingGeneratorNotFound', -9: 'saDeviceNotIdleErr', -8: 'saDeviceNotFoundErr', -7: 'saInvalidModeErr', -6: 'saDeviceNotConfiguredErr', -5: 'saTooManyDevicesErr', -4: 'saInvalidParameterErr', -3: 'saDeviceNotOpenErr', -2: 'saInvalidDeviceErr', -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>
<dd></dd></dl>

<dl class="method">
Expand Down
20 changes: 10 additions & 10 deletions api/generated/qcodes.instrument_drivers.tektronix.html
Original file line number Diff line number Diff line change
Expand Up @@ -258,12 +258,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"> = {'PHASE_DELAY_INPUT_METHOD_N': 'h', 'MARKER2_AMPLITUDE_N': 'd', 'ANALOG_AMPLITUDE_N': 'd', 'ANALOG_FILTER_N': 'h', 'DIGITAL_LOW_N': 'd', 'MARKER1_LOW_N': 'd', 'ANALOG_LOW_N': 'd', 'CHANNEL_SKEW_N': 'd', 'EXTERNAL_ADD_N': 'h', 'OUTPUT_WAVEFORM_NAME_N': 's', 'ANALOG_HIGH_N': 'd', 'DC_OUTPUT_LEVEL_N': 'd', 'DELAY_IN_TIME_N': 'd', 'MARKER1_AMPLITUDE_N': 'd', 'DELAY_IN_POINTS_N': 'd', 'PHASE_N': 'd', 'CHANNEL_STATE_N': 'h', 'DIGITAL_AMPLITUDE_N': 'd', 'DIGITAL_METHOD_N': 'h', 'MARKER2_LOW_N': 'd', 'MARKER1_SKEW_N': 'd', 'MARKER2_OFFSET_N': 'd', 'MARKER1_OFFSET_N': 'd', 'ANALOG_OFFSET_N': 'd', 'MARKER2_SKEW_N': 'd', 'DIGITAL_OFFSET_N': 'd', 'MARKER2_METHOD_N': 'h', 'MARKER1_METHOD_N': 'h', 'MARKER2_HIGH_N': 'd', 'ANALOG_METHOD_N': 'h', 'ANALOG_DIRECT_OUTPUT_N': 'h', 'DIGITAL_HIGH_N': 'd', 'MARKER1_HIGH_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"> = {'PHASE_DELAY_INPUT_METHOD_N': 'h', 'ANALOG_METHOD_N': 'h', 'MARKER2_HIGH_N': 'd', 'OUTPUT_WAVEFORM_NAME_N': 's', 'MARKER1_LOW_N': 'd', 'DIGITAL_OFFSET_N': 'd', 'MARKER1_METHOD_N': 'h', 'ANALOG_OFFSET_N': 'd', 'MARKER2_SKEW_N': 'd', 'PHASE_N': 'd', 'DIGITAL_METHOD_N': 'h', 'DIGITAL_AMPLITUDE_N': 'd', 'MARKER2_METHOD_N': 'h', 'MARKER1_OFFSET_N': 'd', 'ANALOG_LOW_N': 'd', 'MARKER2_AMPLITUDE_N': 'd', 'DELAY_IN_POINTS_N': 'd', 'ANALOG_AMPLITUDE_N': 'd', 'ANALOG_FILTER_N': 'h', 'DIGITAL_LOW_N': 'd', 'MARKER1_SKEW_N': 'd', 'CHANNEL_SKEW_N': 'd', 'DC_OUTPUT_LEVEL_N': 'd', 'MARKER2_OFFSET_N': 'd', 'MARKER1_HIGH_N': 'd', 'DELAY_IN_TIME_N': 'd', 'DIGITAL_HIGH_N': 'd', 'ANALOG_DIRECT_OUTPUT_N': 'h', 'MARKER1_AMPLITUDE_N': 'd', 'ANALOG_HIGH_N': 'd', 'CHANNEL_STATE_N': 'h', 'MARKER2_LOW_N': 'd', 'EXTERNAL_ADD_N': 'h'}</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"> = {'INTERLEAVE_ADJ_AMPLITUDE': 'd', 'TRIGGER_SOURCE': 'h', 'RUN_MODE': 'h', 'RUN_STATE': 'h', 'INTERLEAVE_ADJ_PHASE': 'd', 'TRIGGER_INPUT_POLARITY': 'h', 'COUPLING': 'h', 'TRIGGER_INPUT_THRESHOLD': 'd', 'EXTERNAL_REFERENCE_TYPE': 'h', 'REFERENCE_MULTIPLIER_RATE': 'h', 'REFERENCE_CLOCK_FREQUENCY_SELECTION': 'h', 'CLOCK_SOURCE': 'h', 'EVENT_INPUT_THRESHOLD': 'd', 'INTERNAL_TRIGGER_RATE': 'd', 'TRIGGER_INPUT_IMPEDANCE': 'h', 'SAMPLING_RATE': 'd', 'WAIT_VALUE': 'h', 'HOLD_REPETITION_RATE': 'h', 'TRIGGER_INPUT_SLOPE': 'h', 'REPETITION_RATE': 'd', 'INTERLEAVE': 'h', 'ZEROING': 'h', 'EVENT_INPUT_IMPEDANCE': 'h', 'REFERENCE_SOURCE': 'h', 'JUMP_TIMING': 'h', 'DIVIDER_RATE': 'h', 'EVENT_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>
<code class="descname">AWG_FILE_FORMAT_HEAD</code><em class="property"> = {'REFERENCE_MULTIPLIER_RATE': 'h', 'REPETITION_RATE': 'd', 'RUN_STATE': 'h', 'EXTERNAL_REFERENCE_TYPE': 'h', 'TRIGGER_INPUT_POLARITY': 'h', 'RUN_MODE': 'h', 'EVENT_INPUT_THRESHOLD': 'd', 'EVENT_INPUT_POLARITY': 'h', 'EVENT_INPUT_IMPEDANCE': 'h', 'COUPLING': 'h', 'HOLD_REPETITION_RATE': 'h', 'JUMP_TIMING': 'h', 'SAMPLING_RATE': 'd', 'ZEROING': 'h', 'INTERLEAVE_ADJ_PHASE': 'd', 'TRIGGER_INPUT_SLOPE': 'h', 'DIVIDER_RATE': 'h', 'WAIT_VALUE': 'h', 'REFERENCE_SOURCE': 'h', 'CLOCK_SOURCE': 'h', 'INTERNAL_TRIGGER_RATE': 'd', 'INTERLEAVE_ADJ_AMPLITUDE': 'd', 'REFERENCE_CLOCK_FREQUENCY_SELECTION': 'h', 'TRIGGER_INPUT_IMPEDANCE': 'h', 'INTERLEAVE': 'h', 'TRIGGER_INPUT_THRESHOLD': 'd', 'TRIGGER_SOURCE': '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 Expand Up @@ -370,7 +370,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>packed_waveforms</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/stdtypes.html#dict" title="(in Python v3.5)"><em>dict</em></a>) &#8211; dictionary containing packed waveforms</li>
<li><strong>keys wfname_l</strong> (<em>with</em>) &#8211; </li>
<li><strong>wfname_l</strong> (<em>numpy.ndarray</em>) &#8211; array of waveform names, e.g.
<li><strong>wfname_l</strong> (<a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.12)"><em>numpy.ndarray</em></a>) &#8211; array of waveform names, e.g.
array([[segm1_ch1,segm2_ch1..], [segm1_ch2,segm2_ch2..],...])</li>
<li><strong>nrep</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/stdtypes.html#list" title="(in Python v3.5)"><em>list</em></a>) &#8211; list of len(segments) of integers specifying the
no. of repetions per sequence element.
Expand Down Expand Up @@ -786,17 +786,17 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>wf</strong> (<em>numpy.ndarray</em>) &#8211; A numpy array containing the waveform. The
<li><strong>wf</strong> (<a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.12)"><em>numpy.ndarray</em></a>) &#8211; A numpy array containing the waveform. The
data type of wf is unimportant.</li>
<li><strong>m1</strong> (<em>numpy.ndarray</em>) &#8211; A numpy array containing the first marker.</li>
<li><strong>m2</strong> (<em>numpy.ndarray</em>) &#8211; A numpy array containing the second marker.</li>
<li><strong>m1</strong> (<a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.12)"><em>numpy.ndarray</em></a>) &#8211; A numpy array containing the first marker.</li>
<li><strong>m2</strong> (<a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.12)"><em>numpy.ndarray</em></a>) &#8211; A numpy array containing the second marker.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An array of unsigned 16 bit integers.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">numpy.ndarray</p>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.12)">numpy.ndarray</a></p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
Expand Down Expand Up @@ -883,9 +883,9 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>w</strong> (<em>numpy.ndarray</em>) &#8211; The waveform</li>
<li><strong>m1</strong> (<em>numpy.ndarray</em>) &#8211; Marker1</li>
<li><strong>m2</strong> (<em>numpy.ndarray</em>) &#8211; Marker2</li>
<li><strong>w</strong> (<a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.12)"><em>numpy.ndarray</em></a>) &#8211; The waveform</li>
<li><strong>m1</strong> (<a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.12)"><em>numpy.ndarray</em></a>) &#8211; Marker1</li>
<li><strong>m2</strong> (<a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.12)"><em>numpy.ndarray</em></a>) &#8211; Marker2</li>
<li><strong>wfmname</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/stdtypes.html#str" title="(in Python v3.5)"><em>str</em></a>) &#8211; waveform name</li>
</ul>
</td>
Expand Down

0 comments on commit a58b316

Please sign in to comment.