Generated gh-pages for commit 8033c88

Author: Jens Hedegaard Nielsen <[email protected]>

    Fix parameter warnings (#776)

Author: Documentation Bot

_modules/qcodes/instrument/parameter.html

@@ -679,8 +679,11 @@ <h1>Source code for qcodes.instrument.parameter</h1><div class="highlight"><pre>
     <span class="c1"># Deprecated</span>
     <span class="nd">@property</span>
     <span class="k">def</span> <span class="nf">full_name</span><span class="p">(</span><span class="bp">self</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;Attribute `full_name` is deprecated, please use &#39;</span>
-                      <span class="s1">&#39;str(parameter)&#39;</span><span class="p">)</span>
+<span class="c1">#        This can fully be replaced by str(parameter) in the future we</span>
+<span class="c1">#        may want to deprecate this but the current dataset makes heavy use</span>
+<span class="c1">#        of it in more complicated ways so keep it for now.</span>
+<span class="c1">#        warnings.warn(&#39;Attribute `full_name` is deprecated, please use &#39;</span>
+<span class="c1">#                      &#39;str(parameter)&#39;)</span>
         <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
 
     <span class="k">def</span> <span class="nf">set_validator</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vals</span><span class="p">):</span>

_modules/qcodes/instrument_drivers/Harvard/Decadac.html

@@ -165,7 +165,7 @@
   <h1>Source code for qcodes.instrument_drivers.Harvard.Decadac</h1><div class="highlight"><pre>
 <span></span><span class="kn">from</span> <span class="nn">time</span> <span class="k">import</span> <span class="n">time</span>
 <span class="kn">from</span> <span class="nn">functools</span> <span class="k">import</span> <span class="n">partial</span>
-<span class="kn">from</span> <span class="nn">qcodes</span> <span class="k">import</span> <span class="n">VisaInstrument</span><span class="p">,</span> <span class="n">InstrumentChannel</span><span class="p">,</span> <span class="n">ChannelList</span><span class="p">,</span> <span class="n">ManualParameter</span>
+<span class="kn">from</span> <span class="nn">qcodes</span> <span class="k">import</span> <span class="n">VisaInstrument</span><span class="p">,</span> <span class="n">InstrumentChannel</span><span class="p">,</span> <span class="n">ChannelList</span>
 <span class="kn">from</span> <span class="nn">qcodes.utils</span> <span class="k">import</span> <span class="n">validators</span> <span class="k">as</span> <span class="n">vals</span>
 
 
@@ -364,9 +364,9 @@ <h1>Source code for qcodes.instrument_drivers.Harvard.Decadac</h1><div class="hi
 
         <span class="c1"># Manual parameters to control whether DAC channels should ramp to voltages or jump</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_ramp_val</span> <span class="o">=</span> <span class="n">vals</span><span class="o">.</span><span class="n">Numbers</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">10</span><span class="p">)</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">add_parameter</span><span class="p">(</span><span class="s2">&quot;enable_ramp&quot;</span><span class="p">,</span> <span class="n">parameter_class</span><span class="o">=</span><span class="n">ManualParameter</span><span class="p">,</span> <span class="n">initial_value</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">add_parameter</span><span class="p">(</span><span class="s2">&quot;enable_ramp&quot;</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="kc">False</span><span class="p">,</span>
                            <span class="n">vals</span><span class="o">=</span><span class="n">vals</span><span class="o">.</span><span class="n">Bool</span><span class="p">())</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">add_parameter</span><span class="p">(</span><span class="s2">&quot;ramp_rate&quot;</span><span class="p">,</span> <span class="n">parameter_class</span><span class="o">=</span><span class="n">ManualParameter</span><span class="p">,</span> <span class="n">initial_value</span><span class="o">=</span><span class="mf">0.1</span><span class="p">,</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">add_parameter</span><span class="p">(</span><span class="s2">&quot;ramp_rate&quot;</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="mf">0.1</span><span class="p">,</span>
                            <span class="n">vals</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_ramp_val</span><span class="p">,</span> <span class="n">unit</span><span class="o">=</span><span class="s2">&quot;V/s&quot;</span><span class="p">)</span>
 
         <span class="c1"># Add ramp function to the list of functions</span>

_modules/qcodes/instrument_drivers/QDev/QDac.html

@@ -175,7 +175,6 @@ <h1>Source code for qcodes.instrument_drivers.QDev.QDac</h1><div class="highligh
 <span class="kn">from</span> <span class="nn">operator</span> <span class="k">import</span> <span class="n">xor</span>
 <span class="kn">from</span> <span class="nn">collections</span> <span class="k">import</span> <span class="n">OrderedDict</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.visa</span> <span class="k">import</span> <span class="n">VisaInstrument</span>
 <span class="kn">from</span> <span class="nn">qcodes.utils</span> <span class="k">import</span> <span class="n">validators</span> <span class="k">as</span> <span class="n">vals</span>
 
@@ -294,13 +293,13 @@ <h1>Source code for qcodes.instrument_drivers.QDev.QDac</h1><div class="highligh
             <span class="bp">self</span><span class="o">.</span><span class="n">add_parameter</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;ch</span><span class="si">{:02}</span><span class="s1">_sync_delay&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">i</span><span class="p">),</span>
                                <span class="n">label</span><span class="o">=</span><span class="s1">&#39;Channel </span><span class="si">{}</span><span class="s1"> sync pulse delay&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">i</span><span class="p">),</span>
                                <span class="n">unit</span><span class="o">=</span><span class="s1">&#39;s&#39;</span><span class="p">,</span>
-                               <span class="n">parameter_class</span><span class="o">=</span><span class="n">ManualParameter</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="mi">0</span><span class="p">)</span>
 
             <span class="bp">self</span><span class="o">.</span><span class="n">add_parameter</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;ch</span><span class="si">{:02}</span><span class="s1">_sync_duration&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">i</span><span class="p">),</span>
                                <span class="n">label</span><span class="o">=</span><span class="s1">&#39;Channel </span><span class="si">{}</span><span class="s1"> sync pulse duration&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">i</span><span class="p">),</span>
                                <span class="n">unit</span><span class="o">=</span><span class="s1">&#39;s&#39;</span><span class="p">,</span>
-                               <span class="n">parameter_class</span><span class="o">=</span><span class="n">ManualParameter</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="mf">0.01</span><span class="p">)</span>
 
         <span class="k">for</span> <span class="n">board</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">6</span><span class="p">):</span>
@@ -323,7 +322,7 @@ <h1>Source code for qcodes.instrument_drivers.QDev.QDac</h1><div class="highligh
 
         <span class="bp">self</span><span class="o">.</span><span class="n">add_parameter</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;fast_voltage_set&#39;</span><span class="p">,</span>
                            <span class="n">label</span><span class="o">=</span><span class="s1">&#39;fast voltage set&#39;</span><span class="p">,</span>
-                           <span class="n">parameter_class</span><span class="o">=</span><span class="n">ManualParameter</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">vals</span><span class="o">=</span><span class="n">vals</span><span class="o">.</span><span class="n">Bool</span><span class="p">(),</span>
                            <span class="n">initial_value</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
                            <span class="n">docstring</span><span class="o">=</span><span class="s2">&quot;&quot;&quot;&quot;Toggles if DC voltage set should unset any ramp attached to this channel.</span>

_modules/qcodes/instrument_drivers/QDev/QDac_channels.html

@@ -177,7 +177,6 @@ <h1>Source code for qcodes.instrument_drivers.QDev.QDac_channels</h1><div class=
 
 <span class="kn">from</span> <span class="nn">qcodes.instrument.channel</span> <span class="k">import</span> <span class="n">InstrumentChannel</span><span class="p">,</span> <span class="n">ChannelList</span>
 <span class="kn">from</span> <span class="nn">qcodes.instrument.channel</span> <span class="k">import</span> <span class="n">MultiChannelInstrumentParameter</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.visa</span> <span class="k">import</span> <span class="n">VisaInstrument</span>
 <span class="kn">from</span> <span class="nn">qcodes.utils</span> <span class="k">import</span> <span class="n">validators</span> <span class="k">as</span> <span class="n">vals</span>
 
@@ -258,14 +257,14 @@ <h1>Source code for qcodes.instrument_drivers.QDev.QDac_channels</h1><div class=
         <span class="bp">self</span><span class="o">.</span><span class="n">add_parameter</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;sync_delay&#39;</span><span class="p">,</span>
                            <span class="n">label</span><span class="o">=</span><span class="s1">&#39;Channel </span><span class="si">{}</span><span class="s1"> sync pulse delay&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">channum</span><span class="p">),</span>
                            <span class="n">unit</span><span class="o">=</span><span class="s1">&#39;s&#39;</span><span class="p">,</span>
-                           <span class="n">parameter_class</span><span class="o">=</span><span class="n">ManualParameter</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="mi">0</span>
                            <span class="p">)</span>
 
         <span class="bp">self</span><span class="o">.</span><span class="n">add_parameter</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;sync_duration&#39;</span><span class="p">,</span>
                            <span class="n">label</span><span class="o">=</span><span class="s1">&#39;Channel </span><span class="si">{}</span><span class="s1"> sync pulse duration&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">channum</span><span class="p">),</span>
                            <span class="n">unit</span><span class="o">=</span><span class="s1">&#39;s&#39;</span><span class="p">,</span>
-                           <span class="n">parameter_class</span><span class="o">=</span><span class="n">ManualParameter</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="mf">0.01</span>
                            <span class="p">)</span>
 
@@ -411,7 +410,7 @@ <h1>Source code for qcodes.instrument_drivers.QDev.QDac_channels</h1><div class=
 
         <span class="bp">self</span><span class="o">.</span><span class="n">add_parameter</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;fast_voltage_set&#39;</span><span class="p">,</span>
                            <span class="n">label</span><span class="o">=</span><span class="s1">&#39;fast voltage set&#39;</span><span class="p">,</span>
-                           <span class="n">parameter_class</span><span class="o">=</span><span class="n">ManualParameter</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">vals</span><span class="o">=</span><span class="n">vals</span><span class="o">.</span><span class="n">Bool</span><span class="p">(),</span>
                            <span class="n">initial_value</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
                            <span class="n">docstring</span><span class="o">=</span><span class="s2">&quot;&quot;&quot;&quot;Deprecated with no functionality&quot;&quot;&quot;</span><span class="p">)</span>