Generated gh-pages for commit f1e98e9

Merge: 72185ea de6236b Author: Jens Hedegaard Nielsen <[email protected]> Merge pull request #459 from jenshnielsen/fix/CurrentVoltageParameter
microsoft · Jan 23, 2017 · 96b54cb · 96b54cb
1 parent 7bf0b10
commit 96b54cb
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 21 deletions.
diff --git a/_modules/qcodes/instrument_drivers/ithaco/Ithaco_1211.html b/_modules/qcodes/instrument_drivers/ithaco/Ithaco_1211.html
@@ -138,12 +138,12 @@
 
   <h1>Source code for qcodes.instrument_drivers.ithaco.Ithaco_1211</h1><div class="highlight"><pre>
 <span></span><span class="kn">from</span> <span class="nn">qcodes</span> <span class="k">import</span> <span class="n">Instrument</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.instrument.parameter</span> <span class="k">import</span> <span class="n">MultiParameter</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.utils.validators</span> <span class="k">import</span> <span class="n">Enum</span><span class="p">,</span> <span class="n">Bool</span>
 
 
-<div class="viewcode-block" id="CurrentParameter"><a class="viewcode-back" href="../../../../api/generated/qcodes.instrument_drivers.ithaco.html#qcodes.instrument_drivers.ithaco.Ithaco_1211.CurrentParameter">[docs]</a><span class="k">class</span> <span class="nc">CurrentParameter</span><span class="p">(</span><span class="n">Parameter</span><span class="p">):</span>
+<div class="viewcode-block" id="CurrentParameter"><a class="viewcode-back" href="../../../../api/generated/qcodes.instrument_drivers.ithaco.html#qcodes.instrument_drivers.ithaco.Ithaco_1211.CurrentParameter">[docs]</a><span class="k">class</span> <span class="nc">CurrentParameter</span><span class="p">(</span><span class="n">MultiParameter</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Current measurement via an Ithaco preamp and a measured voltage.</span>
 
@@ -170,13 +170,13 @@ <h1>Source code for qcodes.instrument_drivers.ithaco.Ithaco_1211</h1><div class=
     <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">measured_param</span><span class="p">,</span> <span class="n">c_amp_ins</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s1">&#39;curr&#39;</span><span class="p">):</span>
         <span class="n">p_name</span> <span class="o">=</span> <span class="n">measured_param</span><span class="o">.</span><span class="n">name</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">names</span><span class="o">=</span><span class="p">(</span><span class="n">p_name</span><span class="o">+</span><span class="s1">&#39;_raw&#39;</span><span class="p">,</span> <span class="n">name</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><span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> <span class="n">names</span><span class="o">=</span><span class="p">(</span><span class="n">p_name</span><span class="o">+</span><span class="s1">&#39;_raw&#39;</span><span class="p">,</span> <span class="n">name</span><span class="p">),</span> <span class="n">shapes</span><span class="o">=</span><span class="p">((),</span> <span class="p">()))</span>
 
         <span class="bp">self</span><span class="o">.</span><span class="n">_measured_param</span> <span class="o">=</span> <span class="n">measured_param</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_instrument</span> <span class="o">=</span> <span class="n">c_amp_ins</span>
 
         <span class="n">p_label</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">measured_param</span><span class="p">,</span> <span class="s1">&#39;label&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
-        <span class="n">p_unit</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">measured_param</span><span class="p">,</span> <span class="s1">&#39;units&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
+        <span class="n">p_unit</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">measured_param</span><span class="p">,</span> <span class="s1">&#39;unit&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
         <span class="bp">self</span><span class="o">.</span><span class="n">labels</span> <span class="o">=</span> <span class="p">(</span><span class="n">p_label</span><span class="p">,</span> <span class="s1">&#39;Current&#39;</span><span class="p">)</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">units</span> <span class="o">=</span> <span class="p">(</span><span class="n">p_unit</span><span class="p">,</span> <span class="s1">&#39;A&#39;</span><span class="p">)</span>

diff --git a/_modules/qcodes/instrument_drivers/stanford_research/SR560.html b/_modules/qcodes/instrument_drivers/stanford_research/SR560.html
@@ -139,12 +139,13 @@
   <h1>Source code for qcodes.instrument_drivers.stanford_research.SR560</h1><div class="highlight"><pre>
 <span></span><span class="kn">from</span> <span class="nn">qcodes</span> <span class="k">import</span> <span class="n">Instrument</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">MultiParameter</span>
 <span class="kn">from</span> <span class="nn">qcodes.utils.validators</span> <span class="k">import</span> <span class="n">Bool</span><span class="p">,</span> <span class="n">Enum</span>
 
-<span class="kn">from</span> <span class="nn">qcodes.instrument.parameter</span> <span class="k">import</span> <span class="n">Parameter</span>
 
 
-<div class="viewcode-block" id="VoltageParameter"><a class="viewcode-back" href="../../../../api/generated/qcodes.instrument_drivers.stanford_research.html#qcodes.instrument_drivers.stanford_research.SR560.VoltageParameter">[docs]</a><span class="k">class</span> <span class="nc">VoltageParameter</span><span class="p">(</span><span class="n">Parameter</span><span class="p">):</span>
+
+<div class="viewcode-block" id="VoltageParameter"><a class="viewcode-back" href="../../../../api/generated/qcodes.instrument_drivers.stanford_research.html#qcodes.instrument_drivers.stanford_research.SR560.VoltageParameter">[docs]</a><span class="k">class</span> <span class="nc">VoltageParameter</span><span class="p">(</span><span class="n">MultiParameter</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Amplified voltage measurement via an SR560 preamp and a measured voltage.</span>
 
@@ -171,13 +172,13 @@ <h1>Source code for qcodes.instrument_drivers.stanford_research.SR560</h1><div c
     <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">measured_param</span><span class="p">,</span> <span class="n">v_amp_ins</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s1">&#39;volt&#39;</span><span class="p">):</span>
         <span class="n">p_name</span> <span class="o">=</span> <span class="n">measured_param</span><span class="o">.</span><span class="n">name</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">names</span><span class="o">=</span><span class="p">(</span><span class="n">p_name</span><span class="o">+</span><span class="s1">&#39;_raw&#39;</span><span class="p">,</span> <span class="n">name</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><span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> <span class="n">names</span><span class="o">=</span><span class="p">(</span><span class="n">p_name</span><span class="o">+</span><span class="s1">&#39;_raw&#39;</span><span class="p">,</span> <span class="n">name</span><span class="p">),</span> <span class="n">shapes</span><span class="o">=</span><span class="p">((),</span> <span class="p">()))</span>
 
         <span class="bp">self</span><span class="o">.</span><span class="n">_measured_param</span> <span class="o">=</span> <span class="n">measured_param</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_instrument</span> <span class="o">=</span> <span class="n">v_amp_ins</span>
 
         <span class="n">p_label</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">measured_param</span><span class="p">,</span> <span class="s1">&#39;label&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
-        <span class="n">p_unit</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">measured_param</span><span class="p">,</span> <span class="s1">&#39;units&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
+        <span class="n">p_unit</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">measured_param</span><span class="p">,</span> <span class="s1">&#39;unit&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
         <span class="bp">self</span><span class="o">.</span><span class="n">labels</span> <span class="o">=</span> <span class="p">(</span><span class="n">p_label</span><span class="p">,</span> <span class="s1">&#39;Voltage&#39;</span><span class="p">)</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">units</span> <span class="o">=</span> <span class="p">(</span><span class="n">p_unit</span><span class="p">,</span> <span class="s1">&#39;V&#39;</span><span class="p">)</span>
@@ -214,7 +215,7 @@ <h1>Source code for qcodes.instrument_drivers.stanford_research.SR560</h1><div c
     <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="o">**</span><span class="n">kwargs</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><span class="n">name</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
 
-        <span class="n">cutoffs</span> <span class="o">=</span> <span class="p">[</span><span class="mf">0.03</span><span class="p">,</span> <span class="mf">0.1</span><span class="p">,</span> <span class="mf">0.3</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">30</span><span class="p">,</span> <span class="mi">100</span><span class="p">,</span> <span class="mi">300</span><span class="p">,</span> <span class="mi">1000</span><span class="p">,</span>
+        <span class="n">cutoffs</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;DC&#39;</span><span class="p">,</span> <span class="mf">0.03</span><span class="p">,</span> <span class="mf">0.1</span><span class="p">,</span> <span class="mf">0.3</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">30</span><span class="p">,</span> <span class="mi">100</span><span class="p">,</span> <span class="mi">300</span><span class="p">,</span> <span class="mi">1000</span><span class="p">,</span>
                    <span class="mi">3000</span><span class="p">,</span> <span class="mi">10000</span><span class="p">,</span> <span class="mi">30000</span><span class="p">,</span> <span class="mi">100000</span><span class="p">,</span> <span class="mi">300000</span><span class="p">,</span> <span class="mi">1000000</span><span class="p">]</span>
 
         <span class="n">gains</span> <span class="o">=</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">20</span><span class="p">,</span> <span class="mi">50</span><span class="p">,</span> <span class="mi">100</span><span class="p">,</span> <span class="mi">200</span><span class="p">,</span> <span class="mi">500</span><span class="p">,</span> <span class="mi">1000</span><span class="p">,</span> <span class="mi">2000</span><span class="p">,</span> <span class="mi">5000</span><span class="p">,</span>
@@ -224,14 +225,14 @@ <h1>Source code for qcodes.instrument_drivers.stanford_research.SR560</h1><div c
                            <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="s1">&#39;DC&#39;</span><span class="p">,</span>
                            <span class="n">label</span><span class="o">=</span><span class="s1">&#39;High pass&#39;</span><span class="p">,</span>
-                           <span class="n">units</span><span class="o">=</span><span class="s1">&#39;Hz&#39;</span><span class="p">,</span>
+                           <span class="n">unit</span><span class="o">=</span><span class="s1">&#39;Hz&#39;</span><span class="p">,</span>
                            <span class="n">vals</span><span class="o">=</span><span class="n">Enum</span><span class="p">(</span><span class="o">*</span><span class="n">cutoffs</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="s1">&#39;cutoff_hi&#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">initial_value</span><span class="o">=</span><span class="s1">&#39;1e6&#39;</span><span class="p">,</span>
+                           <span class="n">initial_value</span><span class="o">=</span><span class="mf">1e6</span><span class="p">,</span>
                            <span class="n">label</span><span class="o">=</span><span class="s1">&#39;Low pass&#39;</span><span class="p">,</span>
-                           <span class="n">units</span><span class="o">=</span><span class="s1">&#39;Hz&#39;</span><span class="p">,</span>
+                           <span class="n">unit</span><span class="o">=</span><span class="s1">&#39;Hz&#39;</span><span class="p">,</span>
                            <span class="n">vals</span><span class="o">=</span><span class="n">Enum</span><span class="p">(</span><span class="o">*</span><span class="n">cutoffs</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="s1">&#39;invert&#39;</span><span class="p">,</span>
@@ -244,7 +245,7 @@ <h1>Source code for qcodes.instrument_drivers.stanford_research.SR560</h1><div c
                            <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="mi">10</span><span class="p">,</span>
                            <span class="n">label</span><span class="o">=</span><span class="s1">&#39;Gain&#39;</span><span class="p">,</span>
-                           <span class="n">units</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+                           <span class="n">unit</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">Enum</span><span class="p">(</span><span class="o">*</span><span class="n">gains</span><span class="p">))</span>
 
 <div class="viewcode-block" id="SR560.get_idn"><a class="viewcode-back" href="../../../../api/generated/qcodes.instrument_drivers.stanford_research.html#qcodes.instrument_drivers.stanford_research.SR560.SR560.get_idn">[docs]</a>    <span class="k">def</span> <span class="nf">get_idn</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

diff --git a/api/generated/qcodes.instrument_drivers.ithaco.html b/api/generated/qcodes.instrument_drivers.ithaco.html
@@ -175,7 +175,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dl class="class">
 <dt id="qcodes.instrument_drivers.ithaco.Ithaco_1211.CurrentParameter">
 <em class="property">class </em><code class="descclassname">qcodes.instrument_drivers.ithaco.Ithaco_1211.</code><code class="descname">CurrentParameter</code><span class="sig-paren">(</span><em>measured_param</em>, <em>c_amp_ins</em>, <em>name='curr'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/qcodes/instrument_drivers/ithaco/Ithaco_1211.html#CurrentParameter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#qcodes.instrument_drivers.ithaco.Ithaco_1211.CurrentParameter" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">qcodes.instrument.parameter.Parameter</span></code></p>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">qcodes.instrument.parameter.MultiParameter</span></code></p>
 <p>Current measurement via an Ithaco preamp and a measured voltage.</p>
 <p>To be used when you feed a current into the Ithaco, send the Ithaco&#8217;s
 output voltage to a lockin or other voltage amplifier, and you have