Generated gh-pages for commit 6bfb22d

Author: Jens Hedegaard Nielsen <[email protected]>

    Smaller changes to parameters (#788)

Author: Documentation Bot

_modules/qcodes/instrument/parameter.html

@@ -165,7 +165,7 @@
   <h1>Source code for qcodes.measure</h1><div class="highlight"><pre>
 <span></span><span class="kn">from</span> <span class="nn">datetime</span> <span class="k">import</span> <span class="n">datetime</span>
 
-<span class="kn">from</span> <span class="nn">qcodes.instrument.parameter</span> <span class="k">import</span> <span class="n">ManualParameter</span>
+<span class="kn">from</span> <span class="nn">qcodes.instrument.parameter</span> <span class="k">import</span> <span class="n">Parameter</span>
 <span class="kn">from</span> <span class="nn">qcodes.loops</span> <span class="k">import</span> <span class="n">Loop</span>
 <span class="kn">from</span> <span class="nn">qcodes.actions</span> <span class="k">import</span> <span class="n">_actions_snapshot</span>
 <span class="kn">from</span> <span class="nn">qcodes.utils.helpers</span> <span class="k">import</span> <span class="n">full_class</span>
@@ -183,8 +183,9 @@ <h1>Source code for qcodes.measure</h1><div class="highlight"><pre>
 <span class="sd">            Scalars returned by an action will be saved as length-1 arrays,</span>
 <span class="sd">            with a dummy setpoint for consistency with other DataSets.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
-    <span class="n">dummy_parameter</span> <span class="o">=</span> <span class="n">ManualParameter</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;single&#39;</span><span class="p">,</span>
-                                      <span class="n">label</span><span class="o">=</span><span class="s1">&#39;Single Measurement&#39;</span><span class="p">)</span>
+    <span class="n">dummy_parameter</span> <span class="o">=</span> <span class="n">Parameter</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;single&#39;</span><span class="p">,</span>
+                                <span class="n">label</span><span class="o">=</span><span class="s1">&#39;Single Measurement&#39;</span><span class="p">,</span>
+                                <span class="n">set_cmd</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">get_cmd</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
 
 <div class="viewcode-block" id="Measure.__init__"><a class="viewcode-back" href="../../api/generated/qcodes.measure.Measure.html#qcodes.measure.Measure.__init__">[docs]</a>    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">actions</span><span class="p">):</span>
         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>

_modules/qcodes/measure.html

@@ -277,7 +277,7 @@ <h1>qcodes.ArrayParameter<a class="headerlink" href="#qcodes-arrayparameter" tit
 <tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">snapshot</span></code>([update])</td>
 <td>Decorate a snapshot dictionary with metadata.</td>
 </tr>
-<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">snapshot_base</span></code>([update])</td>
+<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">snapshot_base</span></code>((update:&nbsp;bool&nbsp;=&nbsp;False,&nbsp;…)</td>
 <td>State of the parameter as a JSON-compatible dict.</td>
 </tr>
 <tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">validate</span></code>(value)</td>

api/generated/qcodes.ArrayParameter.html

@@ -221,7 +221,7 @@ <h1>qcodes.ManualParameter<a class="headerlink" href="#qcodes-manualparameter" t
 <tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">snapshot</span></code>([update])</td>
 <td>Decorate a snapshot dictionary with metadata.</td>
 </tr>
-<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">snapshot_base</span></code>([update])</td>
+<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">snapshot_base</span></code>((update:&nbsp;bool&nbsp;=&nbsp;False,&nbsp;…)</td>
 <td>State of the parameter as a JSON-compatible dict.</td>
 </tr>
 <tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">sweep</span></code>(start,&nbsp;stop[,&nbsp;step,&nbsp;num])</td>

api/generated/qcodes.ManualParameter.html

@@ -284,7 +284,7 @@ <h1>qcodes.MultiParameter<a class="headerlink" href="#qcodes-multiparameter" tit
 <tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">snapshot</span></code>([update])</td>
 <td>Decorate a snapshot dictionary with metadata.</td>
 </tr>
-<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">snapshot_base</span></code>([update])</td>
+<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">snapshot_base</span></code>((update:&nbsp;bool&nbsp;=&nbsp;False,&nbsp;…)</td>
 <td>State of the parameter as a JSON-compatible dict.</td>
 </tr>
 <tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">validate</span></code>(value)</td>

api/generated/qcodes.MultiParameter.html

@@ -190,7 +190,7 @@
 <h1>qcodes.Parameter<a class="headerlink" href="#qcodes-parameter" title="Permalink to this headline">¶</a></h1>
 <dl class="class">
 <dt id="qcodes.Parameter">
-<em class="property">class </em><code class="descclassname">qcodes.</code><code class="descname">Parameter</code><span class="sig-paren">(</span><em>name</em>, <em>instrument=None</em>, <em>label=None</em>, <em>unit=None</em>, <em>get_cmd=None</em>, <em>set_cmd=False</em>, <em>initial_value=None</em>, <em>max_val_age=None</em>, <em>vals=None</em>, <em>docstring=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/qcodes/instrument/parameter.html#Parameter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#qcodes.Parameter" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="descclassname">qcodes.</code><code class="descname">Parameter</code><a class="reference internal" href="../../_modules/qcodes/instrument/parameter.html#Parameter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#qcodes.Parameter" title="Permalink to this definition">¶</a></dt>
 <dd><p>A parameter that represents a single degree of freedom.
 This is the standard parameter for Instruments, though it can also be
 used as a variable, i.e. storing/retrieving a value, or be subclassed for
@@ -285,7 +285,7 @@ <h1>qcodes.Parameter<a class="headerlink" href="#qcodes-parameter" title="Permal
 </table>
 <dl class="method">
 <dt id="qcodes.Parameter.__init__">
-<code class="descname">__init__</code><span class="sig-paren">(</span><em>name</em>, <em>instrument=None</em>, <em>label=None</em>, <em>unit=None</em>, <em>get_cmd=None</em>, <em>set_cmd=False</em>, <em>initial_value=None</em>, <em>max_val_age=None</em>, <em>vals=None</em>, <em>docstring=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/qcodes/instrument/parameter.html#Parameter.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#qcodes.Parameter.__init__" title="Permalink to this definition">¶</a></dt>
+<code class="descname">__init__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/qcodes/instrument/parameter.html#Parameter.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#qcodes.Parameter.__init__" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
 <p class="rubric">Methods</p>
@@ -295,7 +295,7 @@ <h1>qcodes.Parameter<a class="headerlink" href="#qcodes-parameter" title="Permal
 <col width="90%" />
 </colgroup>
 <tbody valign="top">
-<tr class="row-odd"><td><a class="reference internal" href="#qcodes.Parameter.__init__" title="qcodes.Parameter.__init__"><code class="xref py py-obj docutils literal"><span class="pre">__init__</span></code></a>(name[,&nbsp;instrument,&nbsp;label,&nbsp;unit,&nbsp;…])</td>
+<tr class="row-odd"><td><a class="reference internal" href="#qcodes.Parameter.__init__" title="qcodes.Parameter.__init__"><code class="xref py py-obj docutils literal"><span class="pre">__init__</span></code></a></td>
 <td></td>
 </tr>
 <tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">get_ramp_values</span></code>(value[,&nbsp;step])</td>
@@ -313,7 +313,7 @@ <h1>qcodes.Parameter<a class="headerlink" href="#qcodes-parameter" title="Permal
 <tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">snapshot</span></code>([update])</td>
 <td>Decorate a snapshot dictionary with metadata.</td>
 </tr>
-<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">snapshot_base</span></code>([update])</td>
+<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">snapshot_base</span></code>((update:&nbsp;bool&nbsp;=&nbsp;False,&nbsp;…)</td>
 <td>State of the parameter as a JSON-compatible dict.</td>
 </tr>
 <tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">sweep</span></code>(start,&nbsp;stop[,&nbsp;step,&nbsp;num])</td>

api/generated/qcodes.Parameter.html

@@ -221,7 +221,7 @@ <h1>qcodes.StandardParameter<a class="headerlink" href="#qcodes-standardparamete
 <tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">snapshot</span></code>([update])</td>
 <td>Decorate a snapshot dictionary with metadata.</td>
 </tr>
-<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">snapshot_base</span></code>([update])</td>
+<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">snapshot_base</span></code>((update:&nbsp;bool&nbsp;=&nbsp;False,&nbsp;…)</td>
 <td>State of the parameter as a JSON-compatible dict.</td>
 </tr>
 <tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">sweep</span></code>(start,&nbsp;stop[,&nbsp;step,&nbsp;num])</td>

api/generated/qcodes.StandardParameter.html

@@ -232,7 +232,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: &quot;The handle is NULL or its type doesn't match the required operation.&quot;, 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: &quot;The handle hasn't own the privilege of the operation the user wanted.&quot;, 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: &quot;The function is not initialized and can't be started.&quot;, 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: &quot;The handle is NULL or its type doesn't match the required operation.&quot;, 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: &quot;The function is not initialized and can't be started.&quot;, 3758096388: 'Not enough memory is available to complete the operation.', 3758096410: 'The interrupt resource is not available.', 3758096399: &quot;The handle hasn't own the privilege of the operation the user wanted.&quot;, 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.Advantech.html

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