Skip to content

Commit abfbe3c

Browse files
Deploying to gh-pages from @ 06f2b3b 🚀
1 parent 19b810b commit abfbe3c

File tree

11 files changed

+224
-43
lines changed

11 files changed

+224
-43
lines changed

_modules/pyaml/control/controlsystem.html

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -638,15 +638,16 @@ <h1>Source code for pyaml.control.controlsystem</h1><div class="highlight"><pre>
638638

639639
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">e</span><span class="p">,</span><span class="n">RFPlant</span><span class="p">):</span>
640640
<span class="n">attachedTrans</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">RFTransmitter</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
641-
<span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="n">e</span><span class="o">.</span><span class="n">_cfg</span><span class="o">.</span><span class="n">transmitters</span><span class="p">:</span>
642-
<span class="n">voltage</span> <span class="o">=</span> <span class="n">RWRFVoltageScalar</span><span class="p">(</span><span class="n">t</span><span class="p">)</span>
643-
<span class="n">phase</span> <span class="o">=</span> <span class="n">RWRFPhaseScalar</span><span class="p">(</span><span class="n">t</span><span class="p">)</span>
644-
<span class="n">nt</span> <span class="o">=</span> <span class="n">t</span><span class="o">.</span><span class="n">attach</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">voltage</span><span class="p">,</span><span class="n">phase</span><span class="p">)</span>
645-
<span class="bp">self</span><span class="o">.</span><span class="n">add_rf_transnmitter</span><span class="p">(</span><span class="n">nt</span><span class="p">)</span>
646-
<span class="n">attachedTrans</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">nt</span><span class="p">)</span>
641+
<span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">_cfg</span><span class="o">.</span><span class="n">transmitters</span><span class="p">:</span>
642+
<span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="n">e</span><span class="o">.</span><span class="n">_cfg</span><span class="o">.</span><span class="n">transmitters</span><span class="p">:</span>
643+
<span class="n">voltage</span> <span class="o">=</span> <span class="n">RWRFVoltageScalar</span><span class="p">(</span><span class="n">t</span><span class="p">)</span>
644+
<span class="n">phase</span> <span class="o">=</span> <span class="n">RWRFPhaseScalar</span><span class="p">(</span><span class="n">t</span><span class="p">)</span>
645+
<span class="n">nt</span> <span class="o">=</span> <span class="n">t</span><span class="o">.</span><span class="n">attach</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">voltage</span><span class="p">,</span><span class="n">phase</span><span class="p">)</span>
646+
<span class="bp">self</span><span class="o">.</span><span class="n">add_rf_transnmitter</span><span class="p">(</span><span class="n">nt</span><span class="p">)</span>
647+
<span class="n">attachedTrans</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">nt</span><span class="p">)</span>
647648

648649
<span class="n">frequency</span> <span class="o">=</span> <span class="n">RWRFFrequencyScalar</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
649-
<span class="n">voltage</span> <span class="o">=</span> <span class="n">RWTotalVoltage</span><span class="p">(</span><span class="n">attachedTrans</span><span class="p">)</span>
650+
<span class="n">voltage</span> <span class="o">=</span> <span class="n">RWTotalVoltage</span><span class="p">(</span><span class="n">attachedTrans</span><span class="p">)</span> <span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">_cfg</span><span class="o">.</span><span class="n">transmitters</span> <span class="k">else</span> <span class="kc">None</span>
650651
<span class="n">ne</span> <span class="o">=</span> <span class="n">e</span><span class="o">.</span><span class="n">attach</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">frequency</span><span class="p">,</span><span class="n">voltage</span><span class="p">)</span>
651652
<span class="bp">self</span><span class="o">.</span><span class="n">add_rf_plant</span><span class="p">(</span><span class="n">ne</span><span class="p">)</span>
652653

_modules/pyaml/lattice/abstract_impl.html

Lines changed: 81 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -929,9 +929,8 @@ <h1>Source code for pyaml.lattice.abstract_impl</h1><div class="highlight"><pre>
929929
<span class="sd"> Class providing read write access to a cavity voltage of a simulator for a given RF trasnmitter.</span>
930930
<span class="sd"> &quot;&quot;&quot;</span>
931931

932-
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">elements</span><span class="p">:</span><span class="nb">list</span><span class="p">[</span><span class="n">at</span><span class="o">.</span><span class="n">Element</span><span class="p">],</span> <span class="n">transmitter</span><span class="p">:</span><span class="n">RFTransmitter</span><span class="p">):</span>
932+
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">elements</span><span class="p">:</span><span class="nb">list</span><span class="p">[</span><span class="n">at</span><span class="o">.</span><span class="n">Element</span><span class="p">]):</span>
933933
<span class="bp">self</span><span class="o">.</span><span class="n">__elements</span> <span class="o">=</span> <span class="n">elements</span>
934-
<span class="bp">self</span><span class="o">.</span><span class="n">__transmitter</span> <span class="o">=</span> <span class="n">transmitter</span>
935934

936935
<div class="viewcode-block" id="RWRFVoltageScalar.get">
937936
<a class="viewcode-back" href="../../../modules/lattice.html#pyaml.lattice.abstract_impl.RWRFVoltageScalar.get">[docs]</a>
@@ -959,7 +958,7 @@ <h1>Source code for pyaml.lattice.abstract_impl</h1><div class="highlight"><pre>
959958
<div class="viewcode-block" id="RWRFVoltageScalar.unit">
960959
<a class="viewcode-back" href="../../../modules/lattice.html#pyaml.lattice.abstract_impl.RWRFVoltageScalar.unit">[docs]</a>
961960
<span class="k">def</span><span class="w"> </span><span class="nf">unit</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
962-
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__transmitter</span><span class="o">.</span><span class="n">_cfg</span><span class="o">.</span><span class="n">voltage</span><span class="o">.</span><span class="n">unit</span><span class="p">()</span></div>
961+
<span class="k">return</span> <span class="s2">&quot;V&quot;</span></div>
963962
</div>
964963

965964

@@ -972,9 +971,8 @@ <h1>Source code for pyaml.lattice.abstract_impl</h1><div class="highlight"><pre>
972971
<span class="sd"> Class providing read write access to a cavity phase of a simulator for a given RF trasnmitter.</span>
973972
<span class="sd"> &quot;&quot;&quot;</span>
974973

975-
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">elements</span><span class="p">:</span><span class="nb">list</span><span class="p">[</span><span class="n">at</span><span class="o">.</span><span class="n">Element</span><span class="p">],</span> <span class="n">transmitter</span><span class="p">:</span><span class="n">RFTransmitter</span><span class="p">):</span>
974+
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">elements</span><span class="p">:</span><span class="nb">list</span><span class="p">[</span><span class="n">at</span><span class="o">.</span><span class="n">Element</span><span class="p">]):</span>
976975
<span class="bp">self</span><span class="o">.</span><span class="n">__elements</span> <span class="o">=</span> <span class="n">elements</span>
977-
<span class="bp">self</span><span class="o">.</span><span class="n">__transmitter</span> <span class="o">=</span> <span class="n">transmitter</span>
978976

979977
<div class="viewcode-block" id="RWRFPhaseScalar.get">
980978
<a class="viewcode-back" href="../../../modules/lattice.html#pyaml.lattice.abstract_impl.RWRFPhaseScalar.get">[docs]</a>
@@ -1001,7 +999,7 @@ <h1>Source code for pyaml.lattice.abstract_impl</h1><div class="highlight"><pre>
1001999
<div class="viewcode-block" id="RWRFPhaseScalar.unit">
10021000
<a class="viewcode-back" href="../../../modules/lattice.html#pyaml.lattice.abstract_impl.RWRFPhaseScalar.unit">[docs]</a>
10031001
<span class="k">def</span><span class="w"> </span><span class="nf">unit</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
1004-
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__transmitter</span><span class="o">.</span><span class="n">_cfg</span><span class="o">.</span><span class="n">phase</span><span class="o">.</span><span class="n">unit</span><span class="p">()</span></div>
1002+
<span class="k">return</span> <span class="s2">&quot;rad&quot;</span></div>
10051003
</div>
10061004

10071005

@@ -1014,10 +1012,9 @@ <h1>Source code for pyaml.lattice.abstract_impl</h1><div class="highlight"><pre>
10141012
<span class="sd"> Class providing read write access to RF frequency of a simulator.</span>
10151013
<span class="sd"> &quot;&quot;&quot;</span>
10161014

1017-
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">elements</span><span class="p">:</span><span class="nb">list</span><span class="p">[</span><span class="n">at</span><span class="o">.</span><span class="n">Element</span><span class="p">],</span> <span class="n">harmonics</span><span class="p">:</span><span class="nb">list</span><span class="p">[</span><span class="nb">float</span><span class="p">],</span> <span class="n">rf</span><span class="p">:</span><span class="n">RFPlant</span> <span class="p">):</span>
1015+
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">elements</span><span class="p">:</span><span class="nb">list</span><span class="p">[</span><span class="n">at</span><span class="o">.</span><span class="n">Element</span><span class="p">],</span> <span class="n">harmonics</span><span class="p">:</span><span class="nb">list</span><span class="p">[</span><span class="nb">float</span><span class="p">]):</span>
10181016
<span class="bp">self</span><span class="o">.</span><span class="n">__elements</span> <span class="o">=</span> <span class="n">elements</span>
10191017
<span class="bp">self</span><span class="o">.</span><span class="n">__harm</span> <span class="o">=</span> <span class="n">harmonics</span>
1020-
<span class="bp">self</span><span class="o">.</span><span class="n">__rf</span> <span class="o">=</span> <span class="n">rf</span>
10211018

10221019
<div class="viewcode-block" id="RWRFFrequencyScalar.get">
10231020
<a class="viewcode-back" href="../../../modules/lattice.html#pyaml.lattice.abstract_impl.RWRFFrequencyScalar.get">[docs]</a>
@@ -1042,7 +1039,82 @@ <h1>Source code for pyaml.lattice.abstract_impl</h1><div class="highlight"><pre>
10421039
<div class="viewcode-block" id="RWRFFrequencyScalar.unit">
10431040
<a class="viewcode-back" href="../../../modules/lattice.html#pyaml.lattice.abstract_impl.RWRFFrequencyScalar.unit">[docs]</a>
10441041
<span class="k">def</span><span class="w"> </span><span class="nf">unit</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
1045-
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__rf</span><span class="o">.</span><span class="n">_cfg</span><span class="o">.</span><span class="n">masterclock</span><span class="o">.</span><span class="n">unit</span><span class="p">()</span></div>
1042+
<span class="k">return</span> <span class="s2">&quot;Hz&quot;</span></div>
1043+
</div>
1044+
1045+
1046+
<span class="c1">#------------------------------------------------------------------------------</span>
1047+
1048+
<div class="viewcode-block" id="RWRFATFrequencyScalar">
1049+
<a class="viewcode-back" href="../../../modules/lattice.html#pyaml.lattice.abstract_impl.RWRFATFrequencyScalar">[docs]</a>
1050+
<span class="k">class</span><span class="w"> </span><span class="nc">RWRFATFrequencyScalar</span><span class="p">(</span><span class="n">abstract</span><span class="o">.</span><span class="n">ReadWriteFloatScalar</span><span class="p">):</span>
1051+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
1052+
<span class="sd"> Class providing read write access to RF frequency of a simulator using</span>
1053+
<span class="sd"> AT methods.</span>
1054+
<span class="sd"> &quot;&quot;&quot;</span>
1055+
1056+
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ring</span><span class="p">:</span> <span class="n">at</span><span class="o">.</span><span class="n">Lattice</span><span class="p">):</span>
1057+
<span class="bp">self</span><span class="o">.</span><span class="n">__ring</span> <span class="o">=</span> <span class="n">ring</span>
1058+
1059+
<div class="viewcode-block" id="RWRFATFrequencyScalar.get">
1060+
<a class="viewcode-back" href="../../../modules/lattice.html#pyaml.lattice.abstract_impl.RWRFATFrequencyScalar.get">[docs]</a>
1061+
<span class="k">def</span><span class="w"> </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">float</span><span class="p">:</span>
1062+
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__ring</span><span class="o">.</span><span class="n">get_rf_frequency</span><span class="p">()</span></div>
1063+
1064+
1065+
<div class="viewcode-block" id="RWRFATFrequencyScalar.set">
1066+
<a class="viewcode-back" href="../../../modules/lattice.html#pyaml.lattice.abstract_impl.RWRFATFrequencyScalar.set">[docs]</a>
1067+
<span class="k">def</span><span class="w"> </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="nb">float</span><span class="p">):</span>
1068+
<span class="bp">self</span><span class="o">.</span><span class="n">__ring</span><span class="o">.</span><span class="n">set_rf_frequency</span><span class="p">(</span><span class="n">value</span><span class="p">)</span></div>
1069+
1070+
1071+
<div class="viewcode-block" id="RWRFATFrequencyScalar.set_and_wait">
1072+
<a class="viewcode-back" href="../../../modules/lattice.html#pyaml.lattice.abstract_impl.RWRFATFrequencyScalar.set_and_wait">[docs]</a>
1073+
<span class="k">def</span><span class="w"> </span><span class="nf">set_and_wait</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="nb">float</span><span class="p">):</span>
1074+
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s2">&quot;Not implemented yet.&quot;</span><span class="p">)</span></div>
1075+
1076+
1077+
<div class="viewcode-block" id="RWRFATFrequencyScalar.unit">
1078+
<a class="viewcode-back" href="../../../modules/lattice.html#pyaml.lattice.abstract_impl.RWRFATFrequencyScalar.unit">[docs]</a>
1079+
<span class="k">def</span><span class="w"> </span><span class="nf">unit</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
1080+
<span class="k">return</span> <span class="s1">&#39;Hz&#39;</span></div>
1081+
</div>
1082+
1083+
1084+
<span class="c1">#------------------------------------------------------------------------------</span>
1085+
1086+
<div class="viewcode-block" id="RWRFATotalVoltageScalar">
1087+
<a class="viewcode-back" href="../../../modules/lattice.html#pyaml.lattice.abstract_impl.RWRFATotalVoltageScalar">[docs]</a>
1088+
<span class="k">class</span><span class="w"> </span><span class="nc">RWRFATotalVoltageScalar</span><span class="p">(</span><span class="n">abstract</span><span class="o">.</span><span class="n">ReadWriteFloatScalar</span><span class="p">):</span>
1089+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
1090+
<span class="sd"> Class providing read write access to a RF voltage of a simulator using AT methods.</span>
1091+
<span class="sd"> &quot;&quot;&quot;</span>
1092+
1093+
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ring</span><span class="p">:</span> <span class="n">at</span><span class="o">.</span><span class="n">Lattice</span><span class="p">):</span>
1094+
<span class="bp">self</span><span class="o">.</span><span class="n">__ring</span> <span class="o">=</span> <span class="n">ring</span>
1095+
1096+
<div class="viewcode-block" id="RWRFATotalVoltageScalar.get">
1097+
<a class="viewcode-back" href="../../../modules/lattice.html#pyaml.lattice.abstract_impl.RWRFATotalVoltageScalar.get">[docs]</a>
1098+
<span class="k">def</span><span class="w"> </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">float</span><span class="p">:</span>
1099+
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__ring</span><span class="o">.</span><span class="n">get_rf_voltage</span><span class="p">()</span></div>
1100+
1101+
1102+
<div class="viewcode-block" id="RWRFATotalVoltageScalar.set">
1103+
<a class="viewcode-back" href="../../../modules/lattice.html#pyaml.lattice.abstract_impl.RWRFATotalVoltageScalar.set">[docs]</a>
1104+
<span class="k">def</span><span class="w"> </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="nb">float</span><span class="p">):</span>
1105+
<span class="bp">self</span><span class="o">.</span><span class="n">__ring</span><span class="o">.</span><span class="n">set_rf_voltage</span><span class="p">(</span><span class="n">value</span><span class="p">)</span></div>
1106+
1107+
1108+
<div class="viewcode-block" id="RWRFATotalVoltageScalar.set_and_wait">
1109+
<a class="viewcode-back" href="../../../modules/lattice.html#pyaml.lattice.abstract_impl.RWRFATotalVoltageScalar.set_and_wait">[docs]</a>
1110+
<span class="k">def</span><span class="w"> </span><span class="nf">set_and_wait</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="nb">float</span><span class="p">):</span>
1111+
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s2">&quot;Not implemented yet.&quot;</span><span class="p">)</span></div>
1112+
1113+
1114+
<div class="viewcode-block" id="RWRFATotalVoltageScalar.unit">
1115+
<a class="viewcode-back" href="../../../modules/lattice.html#pyaml.lattice.abstract_impl.RWRFATotalVoltageScalar.unit">[docs]</a>
1116+
<span class="k">def</span><span class="w"> </span><span class="nf">unit</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
1117+
<span class="k">return</span> <span class="s1">&#39;V&#39;</span></div>
10461118
</div>
10471119

10481120

0 commit comments

Comments
 (0)