Generated gh-pages for commit cb60e46

Author: Jens Hedegaard Nielsen <[email protected]>

    Undeprecate ManualParameter and more parameter changes (#802)

_modules/qcodes/instrument/channel.html

@@ -245,15 +245,15 @@ <h1>Source code for qcodes.instrument.channel</h1><div class="highlight"><pre>
         <span class="bp">self</span><span class="o">.</span><span class="n">_channels</span> <span class="o">=</span> <span class="n">channels</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_param_name</span> <span class="o">=</span> <span class="n">param_name</span>
 
-    <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">:</span>
+    <span class="k">def</span> <span class="nf">get_raw</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">:</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Return a tuple containing the data from each of the channels in the</span>
 <span class="sd">        list</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">chan</span><span class="o">.</span><span class="n">parameters</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_param_name</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> <span class="k">for</span> <span class="n">chan</span>
                      <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_channels</span><span class="p">)</span>
 
-    <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+    <span class="k">def</span> <span class="nf">set_raw</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Set all parameters to this value</span>
 

_modules/qcodes/instrument/parameter.html

@@ -1590,11 +1590,14 @@ <h1>Source code for qcodes.instrument.parameter</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="ManualParameter"><a class="viewcode-back" href="../../../api/generated/qcodes.ManualParameter.html#qcodes.ManualParameter">[docs]</a><span class="k">class</span> <span class="nc">ManualParameter</span><span class="p">(</span><span class="n">Parameter</span><span class="p">):</span>
 <div class="viewcode-block" id="ManualParameter.__init__"><a class="viewcode-back" href="../../../api/generated/qcodes.ManualParameter.html#qcodes.ManualParameter.__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="n">name</span><span class="p">,</span> <span class="n">instrument</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">initial_value</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        A simple alias for a parameter that does not have a set or</span>
+<span class="sd">        a get function. Useful for parameters that do not have a direct</span>
+<span class="sd">        instrument mapping.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> <span class="n">instrument</span><span class="o">=</span><span class="n">instrument</span><span class="p">,</span>
                          <span class="n">get_cmd</span><span class="o">=</span><span class="kc">None</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">initial_value</span><span class="o">=</span><span class="n">initial_value</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
-        <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s1">&#39;Parameter </span><span class="si">{}</span><span class="s1">: `ManualParameter` is deprecated, use &#39;</span>
-                        <span class="s1">&#39;`Parameter` instead with `set_cmd=None`.&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div></div>
+                         <span class="n">initial_value</span><span class="o">=</span><span class="n">initial_value</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div></div>
 </pre></div>
 
            </div>

_modules/qcodes/instrument_drivers/devices.html

@@ -237,12 +237,12 @@ <h1>Source code for qcodes.instrument_drivers.devices</h1><div class="highlight"
         <span class="c1"># extend metadata</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_meta_attrs</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="s2">&quot;division_value&quot;</span><span class="p">])</span>
 
-<div class="viewcode-block" id="VoltageDivider.set"><a class="viewcode-back" href="../../../api/generated/qcodes.instrument_drivers.html#qcodes.instrument_drivers.devices.VoltageDivider.set">[docs]</a>    <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">float</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+<div class="viewcode-block" id="VoltageDivider.set_raw"><a class="viewcode-back" href="../../../api/generated/qcodes.instrument_drivers.html#qcodes.instrument_drivers.devices.VoltageDivider.set_raw">[docs]</a>    <span class="k">def</span> <span class="nf">set_raw</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">float</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
         <span class="n">instrument_value</span> <span class="o">=</span> <span class="n">value</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">division_value</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_save_val</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">v1</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">instrument_value</span><span class="p">)</span></div>
 
-<div class="viewcode-block" id="VoltageDivider.get"><a class="viewcode-back" href="../../../api/generated/qcodes.instrument_drivers.html#qcodes.instrument_drivers.devices.VoltageDivider.get">[docs]</a>    <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Union</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">float</span><span class="p">]:</span>
+<div class="viewcode-block" id="VoltageDivider.get_raw"><a class="viewcode-back" href="../../../api/generated/qcodes.instrument_drivers.html#qcodes.instrument_drivers.devices.VoltageDivider.get_raw">[docs]</a>    <span class="k">def</span> <span class="nf">get_raw</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Union</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">float</span><span class="p">]:</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Returns:</span>
 <span class="sd">            number: value at which was set at the sample</span>

api/generated/qcodes.ManualParameter.html

@@ -191,10 +191,16 @@ <h1>qcodes.ManualParameter<a class="headerlink" href="#qcodes-manualparameter" t
 <dl class="class">
 <dt id="qcodes.ManualParameter">
 <em class="property">class </em><code class="descclassname">qcodes.</code><code class="descname">ManualParameter</code><span class="sig-paren">(</span><em>name</em>, <em>instrument=None</em>, <em>initial_value=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/qcodes/instrument/parameter.html#ManualParameter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#qcodes.ManualParameter" title="Permalink to this definition">¶</a></dt>
-<dd><dl class="method">
+<dd><p>A simple alias for a parameter that does not have a set or
+a get function. Useful for parameters that do not have a direct
+instrument mapping.</p>
+<dl class="method">
 <dt id="qcodes.ManualParameter.__init__">
 <code class="descname">__init__</code><span class="sig-paren">(</span><em>name</em>, <em>instrument=None</em>, <em>initial_value=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/qcodes/instrument/parameter.html#ManualParameter.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#qcodes.ManualParameter.__init__" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
+<dd><p>A simple alias for a parameter that does not have a set or
+a get function. Useful for parameters that do not have a direct
+instrument mapping.</p>
+</dd></dl>
 
 <p class="rubric">Methods</p>
 <table border="1" class="longtable docutils">
@@ -204,7 +210,7 @@ <h1>qcodes.ManualParameter<a class="headerlink" href="#qcodes-manualparameter" t
 </colgroup>
 <tbody valign="top">
 <tr class="row-odd"><td><a class="reference internal" href="#qcodes.ManualParameter.__init__" title="qcodes.ManualParameter.__init__"><code class="xref py py-obj docutils literal"><span class="pre">__init__</span></code></a>(name[,&nbsp;instrument,&nbsp;initial_value])</td>
-<td></td>
+<td>A simple alias for a parameter that does not have a set or a get function.</td>
 </tr>
 <tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">get_delay</span></code>()</td>
 <td></td>

api/generated/qcodes.instrument_drivers.QDev.html

@@ -279,7 +279,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 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>
+<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>
 <dd></dd></dl>
 
 <dl class="method">
@@ -382,7 +382,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 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>
+<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>
 <dd></dd></dl>
 
 <dl class="method">

api/generated/qcodes.instrument_drivers.html

@@ -427,13 +427,14 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 </tbody>
 </table>
 <dl class="method">
-<dt id="qcodes.instrument_drivers.devices.VoltageDivider.get">
-<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; typing.Union[int, float]<a class="reference internal" href="../../_modules/qcodes/instrument_drivers/devices.html#VoltageDivider.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#qcodes.instrument_drivers.devices.VoltageDivider.get" title="Permalink to this definition">¶</a></dt>
+<dt id="qcodes.instrument_drivers.devices.VoltageDivider.get_instrument_value">
+<code class="descname">get_instrument_value</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; typing.Union[int, float]<a class="reference internal" href="../../_modules/qcodes/instrument_drivers/devices.html#VoltageDivider.get_instrument_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#qcodes.instrument_drivers.devices.VoltageDivider.get_instrument_value" title="Permalink to this definition">¶</a></dt>
 <dd><table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">value at which was set at the sample</td>
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">value at which the attached paraemter is (i.e. does
+not account for the scaling)</td>
 </tr>
 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">number</td>
 </tr>
@@ -442,14 +443,13 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 </dd></dl>
 
 <dl class="method">
-<dt id="qcodes.instrument_drivers.devices.VoltageDivider.get_instrument_value">
-<code class="descname">get_instrument_value</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; typing.Union[int, float]<a class="reference internal" href="../../_modules/qcodes/instrument_drivers/devices.html#VoltageDivider.get_instrument_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#qcodes.instrument_drivers.devices.VoltageDivider.get_instrument_value" title="Permalink to this definition">¶</a></dt>
+<dt id="qcodes.instrument_drivers.devices.VoltageDivider.get_raw">
+<code class="descname">get_raw</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; typing.Union[int, float]<a class="reference internal" href="../../_modules/qcodes/instrument_drivers/devices.html#VoltageDivider.get_raw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#qcodes.instrument_drivers.devices.VoltageDivider.get_raw" title="Permalink to this definition">¶</a></dt>
 <dd><table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">value at which the attached paraemter is (i.e. does
-not account for the scaling)</td>
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">value at which was set at the sample</td>
 </tr>
 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">number</td>
 </tr>
@@ -458,8 +458,8 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 </dd></dl>
 
 <dl class="method">
-<dt id="qcodes.instrument_drivers.devices.VoltageDivider.set">
-<code class="descname">set</code><span class="sig-paren">(</span><em>value: typing.Union[int, float]</em><span class="sig-paren">)</span> &#x2192; None<a class="reference internal" href="../../_modules/qcodes/instrument_drivers/devices.html#VoltageDivider.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#qcodes.instrument_drivers.devices.VoltageDivider.set" title="Permalink to this definition">¶</a></dt>
+<dt id="qcodes.instrument_drivers.devices.VoltageDivider.set_raw">
+<code class="descname">set_raw</code><span class="sig-paren">(</span><em>value: typing.Union[int, float]</em><span class="sig-paren">)</span> &#x2192; None<a class="reference internal" href="../../_modules/qcodes/instrument_drivers/devices.html#VoltageDivider.set_raw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#qcodes.instrument_drivers.devices.VoltageDivider.set_raw" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
 </dd></dl>

api/generated/qcodes.instrument_drivers.ithaco.html

@@ -224,7 +224,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>