Generated gh-pages for commit 05da894

Author: peendebak <P.T.eendebak@tudelft.nl>

    Add help command, add fix for new users (#646)

api/generated/qcodes.instrument_drivers.Advantech.html

@@ -233,7 +233,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <p>Tested with driver version 3.1.10.0 and ddl version 3.1.12.1.</p>
 <dl class="attribute">
 <dt id="qcodes.instrument_drivers.Advantech.PCIE_1751.Advantech_PCIE_1751.ERRORMSG">
-<code class="descname">ERRORMSG</code><em class="property"> = {0: ‘The operation is completed successfully.’, 2684354560: ‘The interrupt resource is not available.’, 2684354561: ‘The parameter is out of the range.’, 2684354562: ‘The property value is out of range.’, 2684354563: ‘The property value is not supported.’, 2684354564: ‘The property value conflicts with the current state.’, 2684354565: ‘The value range of all channels in a group should be same, such as 4~20mA of PCI-1724.’, 3758096384: “The handle is NULL or its type doesn’t match the required operation.”, 3758096385: ‘The parameter value is out of range.’, 3758096386: ‘The parameter value is not supported.’, 3758096387: ‘The parameter value format is not the expected.’, 3758096388: ‘Not enough memory is available to complete the operation.’, 3758096389: ‘The data buffer is null.’, 3758096390: ‘The data buffer is too small for the operation.’, 3758096391: ‘The data length exceeded the limitation.’, 3758096392: ‘The required function is not supported.’, 3758096393: ‘The required event is not supported.’, 3758096394: ‘The required property is not supported.’, 3758096395: ‘The required property is read-only.’, 3758096396: ‘The specified property value conflicts with the current state.’, 3758096397: ‘The specified property value is out of range.’, 3758096398: ‘The specified property value is not supported.’, 3758096399: “The handle hasn’t own the privilege of the operation the user wanted.”, 3758096400: ‘The required privilege is not available because someone else had own it.’, 3758096401: ‘The driver of specified device was not found.’, 3758096402: ‘The driver version of the specified device mismatched.’, 3758096403: ‘The loaded driver count exceeded the limitation.’, 3758096404: ‘The device is not opened.’, 3758096405: ‘The required device does not exist.’, 3758096406: ‘The required device is unrecognized by driver.’, 3758096407: ‘The configuration data of the specified device is lost or unavailable.’, 3758096408: “The function is not initialized and can’t be started.”, 3758096409: ‘The function is busy.’, 3758096410: ‘The interrupt resource is not available.’, 3758096411: ‘The DMA channel is not available.’, 3758096412: ‘Time out when reading/writing the device.’, 3758096413: ‘The given signature does not match with the device current one.’, 3758096414: ‘The function cannot be executed while the buffered AI is running.’, 3758096415: ‘The value range is not available in single-ended mode.’, 3758161919: ‘Undefined error.’}</em><a class="headerlink" href="#qcodes.instrument_drivers.Advantech.PCIE_1751.Advantech_PCIE_1751.ERRORMSG" title="Permalink to this definition">¶</a></dt>
+<code class="descname">ERRORMSG</code><em class="property"> = {0: ‘The operation is completed successfully.’, 2684354560: ‘The interrupt resource is not available.’, 2684354562: ‘The property value is out of range.’, 2684354563: ‘The property value is not supported.’, 2684354564: ‘The property value conflicts with the current state.’, 2684354565: ‘The value range of all channels in a group should be same, such as 4~20mA of PCI-1724.’, 3758096384: “The handle is NULL or its type doesn’t match the required operation.”, 2684354561: ‘The parameter is out of the range.’, 3758096392: ‘The required function is not supported.’, 3758096393: ‘The required event is not supported.’, 3758096394: ‘The required property is not supported.’, 3758096395: ‘The required property is read-only.’, 3758096396: ‘The specified property value conflicts with the current state.’, 3758096386: ‘The parameter value is not supported.’, 3758096398: ‘The specified property value is not supported.’, 3758096397: ‘The specified property value is out of range.’, 3758096400: ‘The required privilege is not available because someone else had own it.’, 3758096401: ‘The driver of specified device was not found.’, 3758096402: ‘The driver version of the specified device mismatched.’, 3758096387: ‘The parameter value format is not the expected.’, 3758096404: ‘The device is not opened.’, 3758096405: ‘The required device does not exist.’, 3758096406: ‘The required device is unrecognized by driver.’, 3758096407: ‘The configuration data of the specified device is lost or unavailable.’, 3758096408: “The function is not initialized and can’t be started.”, 3758096388: ‘Not enough memory is available to complete the operation.’, 3758096410: ‘The interrupt resource is not available.’, 3758096399: “The handle hasn’t own the privilege of the operation the user wanted.”, 3758096412: ‘Time out when reading/writing the device.’, 3758096413: ‘The given signature does not match with the device current one.’, 3758096414: ‘The function cannot be executed while the buffered AI is running.’, 3758096389: ‘The data buffer is null.’, 3758096411: ‘The DMA channel is not available.’, 3758096385: ‘The parameter value is out of range.’, 3758096390: ‘The data buffer is too small for the operation.’, 3758096391: ‘The data length exceeded the limitation.’, 3758096403: ‘The loaded driver count exceeded the limitation.’, 3758096409: ‘The function is busy.’, 3758096415: ‘The value range is not available in single-ended mode.’, 3758161919: ‘Undefined error.’}</em><a class="headerlink" href="#qcodes.instrument_drivers.Advantech.PCIE_1751.Advantech_PCIE_1751.ERRORMSG" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
 <dl class="method">

api/generated/qcodes.instrument_drivers.QDev.html

@@ -275,7 +275,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
 <dl class="attribute">
 <dt id="qcodes.instrument_drivers.QDev.QDac.QDac.voltage_range_status">
-<code class="descname">voltage_range_status</code><em class="property"> = {‘X 1’: 10, ‘X 0.1’: 1}</em><a class="headerlink" href="#qcodes.instrument_drivers.QDev.QDac.QDac.voltage_range_status" title="Permalink to this definition">¶</a></dt>
+<code class="descname">voltage_range_status</code><em class="property"> = {‘X 0.1’: 1, ‘X 1’: 10}</em><a class="headerlink" href="#qcodes.instrument_drivers.QDev.QDac.QDac.voltage_range_status" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
 <dl class="method">
@@ -373,7 +373,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
 <dl class="attribute">
 <dt id="qcodes.instrument_drivers.QDev.QDac_channels.QDac.voltage_range_status">
-<code class="descname">voltage_range_status</code><em class="property"> = {‘X 1’: 10, ‘X 0.1’: 1}</em><a class="headerlink" href="#qcodes.instrument_drivers.QDev.QDac_channels.QDac.voltage_range_status" title="Permalink to this definition">¶</a></dt>
+<code class="descname">voltage_range_status</code><em class="property"> = {‘X 0.1’: 1, ‘X 1’: 10}</em><a class="headerlink" href="#qcodes.instrument_drivers.QDev.QDac_channels.QDac.voltage_range_status" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
 <dl class="method">

api/generated/qcodes.instrument_drivers.american_magnetics.html

@@ -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>
@@ -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>

api/generated/qcodes.instrument_drivers.ithaco.html

@@ -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>

api/generated/qcodes.instrument_drivers.signal_hound.html

@@ -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, ‘saFrequencyRangeErr’: -99, ‘saInvalidDetectorErr’: -95, ‘saInvalidScaleErr’: -94, ‘saBandwidthErr’: -91, ‘saExternalReferenceNotFound’: -89, ‘saOvenColdErr’: -20, ‘saInternetErr’: -12, ‘saUSBCommErr’: -11, ‘saTrackingGeneratorNotFound’: -10, ‘saDeviceNotIdleErr’: -9, ‘saDeviceNotFoundErr’: -8, ‘saInvalidModeErr’: -7, ‘saNotConfiguredErr’: -6, ‘saDeviceNotConfiguredErr’: -6, ‘saTooManyDevicesErr’: -5, ‘saInvalidParameterErr’: -4, ‘saDeviceNotOpenErr’: -3, ‘saInvalidDeviceErr’: -2, ‘saNullPtrErr’: -1, ‘saNoError’: 0, ‘saNoCorrections’: 1, ‘saCompressionWarning’: 2, ‘saParameterClamped’: 3, ‘saBandwidthClamped’: 4}</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"> = {‘saTooManyDevicesErr’: -5, ‘saDeviceNotIdleErr’: -9, ‘saInternetErr’: -12, ‘saExternalReferenceNotFound’: -89, ‘saParameterClamped’: 3, ‘saNoCorrections’: 1, ‘saDeviceNotOpenErr’: -3, ‘saUSBCommErr’: -11, ‘saBandwidthClamped’: 4, ‘saOvenColdErr’: -20, ‘saInvalidModeErr’: -7, ‘saNoError’: 0, ‘saInvalidParameterErr’: -4, ‘saInvalidScaleErr’: -94, ‘saDeviceNotFoundErr’: -8, ‘saInvalidDetectorErr’: -95, ‘saInvalidDeviceErr’: -2, ‘saDeviceNotConfiguredErr’: -6, ‘saUnknownErr’: -666, ‘saBandwidthErr’: -91, ‘saNullPtrErr’: -1, ‘saCompressionWarning’: 2, ‘saTrackingGeneratorNotFound’: -10, ‘saFrequencyRangeErr’: -99, ‘saNotConfiguredErr’: -6}</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"> = {-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"> = {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: ‘saNotConfiguredErr’, -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">