updated docs

oop_imsrg/doc/generator.html

@@ -38,7 +38,8 @@
 <dt><font face="helvetica, arial"><a href="generator.html#Generator">Generator</a>
 </font></dt><dd>
 <dl>
-<dt><font face="helvetica, arial"><a href="generator.html#WegnerGenerator">WegnerGenerator</a>
+<dt><font face="helvetica, arial"><a href="generator.html#BrillouinGenerator">BrillouinGenerator</a>
+</font></dt><dt><font face="helvetica, arial"><a href="generator.html#WegnerGenerator">WegnerGenerator</a>
 </font></dt><dd>
 <dl>
 <dt><font face="helvetica, arial"><a href="generator.html#WegnerGenerator3B">WegnerGenerator3B</a>
@@ -55,6 +56,48 @@
 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 <tr bgcolor="#ffc8d8">
 <td colspan=3 valign=bottom>&nbsp;<br>
+<font color="#000000" face="helvetica, arial"><a name="BrillouinGenerator">class <strong>BrillouinGenerator</strong></a>(<a href="generator.html#Generator">Generator</a>)</font></td></tr>
+    
+<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
+<td colspan=2><tt><a href="#BrillouinGenerator">BrillouinGenerator</a>(h)<br>
+&nbsp;<br>
+Calculate&nbsp;Brillouin&nbsp;generator&nbsp;for&nbsp;a&nbsp;normal&nbsp;ordered&nbsp;Hamiltonian.<br>&nbsp;</tt></td></tr>
+<tr><td>&nbsp;</td>
+<td width="100%"><dl><dt>Method resolution order:</dt>
+<dd><a href="generator.html#BrillouinGenerator">BrillouinGenerator</a></dd>
+<dd><a href="generator.html#Generator">Generator</a></dd>
+<dd><a href="builtins.html#object">builtins.object</a></dd>
+</dl>
+<hr>
+Methods defined here:<br>
+<dl><dt><a name="BrillouinGenerator-__init__"><strong>__init__</strong></a>(self, h)</dt><dd><tt>Initialize&nbsp;self.&nbsp;&nbsp;See&nbsp;help(type(self))&nbsp;for&nbsp;accurate&nbsp;signature.</tt></dd></dl>
+
+<dl><dt><a name="BrillouinGenerator-calc_eta"><strong>calc_eta</strong></a>(self)</dt></dl>
+
+<hr>
+Data descriptors defined here:<br>
+<dl><dt><strong>G</strong></dt>
+<dd><tt>Returns:<br>
+&nbsp;<br>
+f&nbsp;--&nbsp;two-body&nbsp;tensor&nbsp;elements&nbsp;(initialized&nbsp;by&nbsp;Hamiltonian&nbsp;object)</tt></dd>
+</dl>
+<dl><dt><strong>f</strong></dt>
+<dd><tt>Returns:<br>
+&nbsp;<br>
+f&nbsp;--&nbsp;one-body&nbsp;tensor&nbsp;elements&nbsp;(initialized&nbsp;by&nbsp;Hamiltonian&nbsp;object)</tt></dd>
+</dl>
+<hr>
+Data descriptors inherited from <a href="generator.html#Generator">Generator</a>:<br>
+<dl><dt><strong>__dict__</strong></dt>
+<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
+</dl>
+<dl><dt><strong>__weakref__</strong></dt>
+<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
+</dl>
+</td></tr></table> <p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#ffc8d8">
+<td colspan=3 valign=bottom>&nbsp;<br>
 <font color="#000000" face="helvetica, arial"><a name="Generator">class <strong>Generator</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
     
 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>

oop_imsrg/doc/main.html

@@ -48,21 +48,48 @@ y -- in this case, 1D array that contain
 (additional&nbsp;parameters)<br>
 hamiltonian&nbsp;--&nbsp;Hamiltonian&nbsp;object<br>
 occ_tensors&nbsp;--&nbsp;OccupationTensors&nbsp;object<br>
-generator&nbsp;--&nbsp;Generator&nbsp;object<br>
-flow&nbsp;--&nbsp;Flow&nbsp;object<br>
+generator&nbsp;&nbsp;&nbsp;--&nbsp;Generator&nbsp;object<br>
+flow&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--&nbsp;Flow&nbsp;object<br>
 &nbsp;<br>
 Returns:<br>
 &nbsp;<br>
 dy&nbsp;--&nbsp;next&nbsp;step&nbsp;in&nbsp;flow</tt></dd></dl>
  <dl><dt><a name="-get_vacuum_coeffs"><strong>get_vacuum_coeffs</strong></a>(E, f, G, basis, holes)</dt></dl>
  <dl><dt><a name="-main"><strong>main</strong></a>(n_holes, n_particles, ref=[], d=1.0, g=0.5, pb=0.0, verbose=1, flow_data_log=0, generator='wegner')</dt><dd><tt>Main&nbsp;method&nbsp;uses&nbsp;scipy.integrate.ode&nbsp;to&nbsp;solve&nbsp;the&nbsp;IMSRG(2)&nbsp;flow<br>
-equations.</tt></dd></dl>
+equations.<br>
+&nbsp;<br>
+Arguments:<br>
+&nbsp;<br>
+n_holes&nbsp;--&nbsp;number&nbsp;of&nbsp;hole&nbsp;states&nbsp;in&nbsp;the&nbsp;SP&nbsp;basis&nbsp;(int)<br>
+n_particles&nbsp;--&nbsp;number&nbsp;of&nbsp;particle&nbsp;states&nbsp;in&nbsp;the&nbsp;SP&nbsp;basis&nbsp;(int)<br>
+&nbsp;<br>
+Keyword&nbsp;arguments:<br>
+&nbsp;<br>
+ref&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--&nbsp;reference&nbsp;state&nbsp;for&nbsp;the&nbsp;IM-SRG&nbsp;flow&nbsp;(1D&nbsp;array)<br>
+d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--&nbsp;energy&nbsp;spacing&nbsp;in&nbsp;Pairing&nbsp;model&nbsp;(default:&nbsp;1.0)<br>
+g&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--&nbsp;pairing&nbsp;strength&nbsp;in&nbsp;Pairing&nbsp;model&nbsp;(default:&nbsp;0.5)<br>
+pb&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--&nbsp;pair-breaking&nbsp;in&nbsp;Pairing-plus-ph&nbsp;model&nbsp;(default:&nbsp;0.0)<br>
+verbose&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--&nbsp;toggles&nbsp;output&nbsp;of&nbsp;flow&nbsp;information<br>
+flow_data_log&nbsp;--&nbsp;toggles&nbsp;output&nbsp;of&nbsp;flow&nbsp;data&nbsp;(pickled&nbsp;IM-SRG&nbsp;coefficients&nbsp;every&nbsp;10&nbsp;integrator&nbsp;steps)<br>
+generator&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--&nbsp;specify&nbsp;generator&nbsp;to&nbsp;produce&nbsp;IM-SRG&nbsp;flow<br>
+&nbsp;<br>
+Returns:<br>
+&nbsp;<br>
+convergence&nbsp;--&nbsp;0&nbsp;if&nbsp;diverged,&nbsp;1&nbsp;if&nbsp;converged&nbsp;(little&nbsp;bit&nbsp;outdated)<br>
+iters&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--&nbsp;number&nbsp;of&nbsp;iterations&nbsp;before&nbsp;integrator&nbsp;stopped<br>
+d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--&nbsp;energy&nbsp;spacing&nbsp;in&nbsp;pairing&nbsp;model<br>
+g&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--&nbsp;pairing&nbsp;strength&nbsp;in&nbsp;pairing&nbsp;model<br>
+pb&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--&nbsp;pair-breaking&nbsp;strength&nbsp;in&nbsp;Pairing-plus-ph&nbsp;model<br>
+num_sp&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--&nbsp;number&nbsp;of&nbsp;single&nbsp;particle&nbsp;states<br>
+s_vals&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--&nbsp;1D&nbsp;array&nbsp;of&nbsp;flow&nbsp;parameter&nbsp;values<br>
+E_vals&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--&nbsp;1D&nbsp;array&nbsp;of&nbsp;zero-body&nbsp;energy&nbsp;values<br>
+time_str&nbsp;&nbsp;&nbsp;&nbsp;--&nbsp;time&nbsp;taken&nbsp;for&nbsp;flow&nbsp;completion&nbsp;(string)</tt></dd></dl>
  <dl><dt><a name="-ravel"><strong>ravel</strong></a>(y, bas_len)</dt><dd><tt>Transforms&nbsp;1D&nbsp;array&nbsp;into&nbsp;E,&nbsp;f,&nbsp;and&nbsp;G.&nbsp;Facilitates<br>
 compatability&nbsp;with&nbsp;scipy.integrate.ode.<br>
 &nbsp;<br>
-Arugments:<br>
+Arguments:<br>
 &nbsp;<br>
-y&nbsp;--&nbsp;1D&nbsp;data&nbsp;array&nbsp;(output&nbsp;from&nbsp;unravel)<br>
+y&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--&nbsp;1D&nbsp;data&nbsp;array&nbsp;(output&nbsp;from&nbsp;unravel)<br>
 bas_len&nbsp;--&nbsp;length&nbsp;of&nbsp;single&nbsp;particle&nbsp;basis<br>
 &nbsp;<br>
 Returns:<br>