Updated docs for v0.1-rc release.

pyne · Apr 23, 2012 · 7295e21 · 7295e21
1 parent c54e86e
commit 7295e21
Show file tree

Hide file tree

Showing 67 changed files with 1,472 additions and 709 deletions.
diff --git a/_modules/index.html b/_modules/index.html
@@ -8,14 +8,14 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Overview: module code &mdash; PyNE 0.1</title>
+    <title>Overview: module code &mdash; PyNE 0.1-rc</title>
     <link rel="stylesheet" href="../_static/cloud.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="../" type="text/css" />
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '0.1',
+        VERSION:     '0.1-rc',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -28,7 +28,7 @@
     <script type="text/javascript" src="../_static/toggle_sections.js"></script>
     <script type="text/javascript" src="../_static/toggle_sidebar.js"></script>
     <link rel="shortcut icon" href="../_static/pyne_icon.ico"/>
-    <link rel="top" title="PyNE 0.1" href="../index.html" /> 
+    <link rel="top" title="PyNE 0.1-rc" href="../index.html" /> 
   </head>
   <body>
     <div class="relbar-top">

diff --git a/_modules/pyne/ace.html b/_modules/pyne/ace.html
diff --git a/_modules/pyne/bins.html b/_modules/pyne/bins.html
@@ -8,14 +8,14 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>pyne.bins &mdash; PyNE 0.1</title>
+    <title>pyne.bins &mdash; PyNE 0.1-rc</title>
     <link rel="stylesheet" href="../../_static/cloud.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="../../" type="text/css" />
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../',
-        VERSION:     '0.1',
+        VERSION:     '0.1-rc',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -28,7 +28,7 @@
     <script type="text/javascript" src="../../_static/toggle_sections.js"></script>
     <script type="text/javascript" src="../../_static/toggle_sidebar.js"></script>
     <link rel="shortcut icon" href="../../_static/pyne_icon.ico"/>
-    <link rel="top" title="PyNE 0.1" href="../../index.html" />
+    <link rel="top" title="PyNE 0.1-rc" href="../../index.html" />
     <link rel="up" title="Module code" href="../index.html" /> 
   </head>
   <body>

diff --git a/_modules/pyne/cccc.html b/_modules/pyne/cccc.html
@@ -8,14 +8,14 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>pyne.cccc &mdash; PyNE 0.1</title>
+    <title>pyne.cccc &mdash; PyNE 0.1-rc</title>
     <link rel="stylesheet" href="../../_static/cloud.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="../../" type="text/css" />
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../',
-        VERSION:     '0.1',
+        VERSION:     '0.1-rc',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -28,7 +28,7 @@
     <script type="text/javascript" src="../../_static/toggle_sections.js"></script>
     <script type="text/javascript" src="../../_static/toggle_sidebar.js"></script>
     <link rel="shortcut icon" href="../../_static/pyne_icon.ico"/>
-    <link rel="top" title="PyNE 0.1" href="../../index.html" />
+    <link rel="top" title="PyNE 0.1-rc" href="../../index.html" />
     <link rel="up" title="Module code" href="../index.html" /> 
   </head>
   <body>

diff --git a/_modules/pyne/dbgen/atomic_weight.html b/_modules/pyne/dbgen/atomic_weight.html
@@ -8,14 +8,14 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>pyne.dbgen.atomic_weight &mdash; PyNE 0.1</title>
+    <title>pyne.dbgen.atomic_weight &mdash; PyNE 0.1-rc</title>
     <link rel="stylesheet" href="../../../_static/cloud.css" type="text/css" />
     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="../../../" type="text/css" />
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../../',
-        VERSION:     '0.1',
+        VERSION:     '0.1-rc',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -28,7 +28,7 @@
     <script type="text/javascript" src="../../../_static/toggle_sections.js"></script>
     <script type="text/javascript" src="../../../_static/toggle_sidebar.js"></script>
     <link rel="shortcut icon" href="../../../_static/pyne_icon.ico"/>
-    <link rel="top" title="PyNE 0.1" href="../../../index.html" />
+    <link rel="top" title="PyNE 0.1-rc" href="../../../index.html" />
     <link rel="up" title="Module code" href="../../index.html" /> 
   </head>
   <body>
@@ -69,6 +69,7 @@ <h1>Source code for pyne.dbgen.atomic_weight</h1><div class="highlight"><pre>
 <span class="kn">import</span> <span class="nn">tables</span> <span class="kn">as</span> <span class="nn">tb</span>
 
 <span class="kn">from</span> <span class="nn">pyne</span> <span class="kn">import</span> <span class="n">nucname</span>
+<span class="kn">from</span> <span class="nn">pyne.dbgen.api</span> <span class="kn">import</span> <span class="n">BASIC_FILTERS</span>
 <span class="kn">from</span> <span class="nn">pyne.dbgen.kaeri</span> <span class="kn">import</span> <span class="n">grab_kaeri_nuclide</span><span class="p">,</span> <span class="n">parse_for_natural_isotopes</span>
 
 <span class="c"># Note that since ground state and meta-stable isotopes are of the same atomic weight, </span>
@@ -249,7 +250,7 @@ <h1>Source code for pyne.dbgen.atomic_weight</h1><div class="highlight"><pre>
     <span class="c">#A = np.array(A, dtype=atomic_weight_dtype)</span>
 
     <span class="c"># Open the HDF5 File</span>
-    <span class="n">kdb</span> <span class="o">=</span> <span class="n">tb</span><span class="o">.</span><span class="n">openFile</span><span class="p">(</span><span class="n">nuc_data</span><span class="p">,</span> <span class="s">&#39;a&#39;</span><span class="p">)</span>
+    <span class="n">kdb</span> <span class="o">=</span> <span class="n">tb</span><span class="o">.</span><span class="n">openFile</span><span class="p">(</span><span class="n">nuc_data</span><span class="p">,</span> <span class="s">&#39;a&#39;</span><span class="p">,</span> <span class="n">filters</span><span class="o">=</span><span class="n">BASIC_FILTERS</span><span class="p">)</span>
 
     <span class="c"># Make a new the table</span>
     <span class="n">Atable</span> <span class="o">=</span> <span class="n">kdb</span><span class="o">.</span><span class="n">createTable</span><span class="p">(</span><span class="s">&quot;/&quot;</span><span class="p">,</span> <span class="s">&quot;atomic_weight&quot;</span><span class="p">,</span> <span class="n">atomic_weight_desc</span><span class="p">,</span> 

diff --git a/_modules/pyne/dbgen/cinder.html b/_modules/pyne/dbgen/cinder.html
@@ -8,14 +8,14 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>pyne.dbgen.cinder &mdash; PyNE 0.1</title>
+    <title>pyne.dbgen.cinder &mdash; PyNE 0.1-rc</title>
     <link rel="stylesheet" href="../../../_static/cloud.css" type="text/css" />
     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="../../../" type="text/css" />
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../../',
-        VERSION:     '0.1',
+        VERSION:     '0.1-rc',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -28,7 +28,7 @@
     <script type="text/javascript" src="../../../_static/toggle_sections.js"></script>
     <script type="text/javascript" src="../../../_static/toggle_sidebar.js"></script>
     <link rel="shortcut icon" href="../../../_static/pyne_icon.ico"/>
-    <link rel="top" title="PyNE 0.1" href="../../../index.html" />
+    <link rel="top" title="PyNE 0.1-rc" href="../../../index.html" />
     <link rel="up" title="Module code" href="../../index.html" /> 
   </head>
   <body>
@@ -71,7 +71,7 @@ <h1>Source code for pyne.dbgen.cinder</h1><div class="highlight"><pre>
 
 <span class="kn">from</span> <span class="nn">pyne</span> <span class="kn">import</span> <span class="n">nucname</span>
 <span class="kn">from</span> <span class="nn">pyne.utils</span> <span class="kn">import</span> <span class="n">to_barns</span>
-
+<span class="kn">from</span> <span class="nn">pyne.dbgen.api</span> <span class="kn">import</span> <span class="n">BASIC_FILTERS</span>
 
 <div class="viewcode-block" id="grab_cinder_dat"><a class="viewcode-back" href="../../../libref/dbgen/cinder.html#pyne.dbgen.cinder.grab_cinder_dat">[docs]</a><span class="k">def</span> <span class="nf">grab_cinder_dat</span><span class="p">(</span><span class="n">build_dir</span><span class="o">=</span><span class="s">&quot;&quot;</span><span class="p">,</span> <span class="n">datapath</span><span class="o">=</span><span class="s">&#39;&#39;</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;Grabs the cinder.dat file from the DATAPATH directory if not already present.&quot;&quot;&quot;</span>
@@ -178,7 +178,7 @@ <h1>Source code for pyne.dbgen.cinder</h1><div class="highlight"><pre>
 <span class="sd">        Directory with cinder.dat file.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="c"># Open the HDF5 File</span>
-    <span class="n">db</span> <span class="o">=</span> <span class="n">tb</span><span class="o">.</span><span class="n">openFile</span><span class="p">(</span><span class="n">nuc_data</span><span class="p">,</span> <span class="s">&#39;a&#39;</span><span class="p">)</span>
+    <span class="n">db</span> <span class="o">=</span> <span class="n">tb</span><span class="o">.</span><span class="n">openFile</span><span class="p">(</span><span class="n">nuc_data</span><span class="p">,</span> <span class="s">&#39;a&#39;</span><span class="p">,</span> <span class="n">filters</span><span class="o">=</span><span class="n">BASIC_FILTERS</span><span class="p">)</span>
 
     <span class="c"># Ensure that the appropriate file structure is present</span>
     <span class="n">_init_cinder</span><span class="p">(</span><span class="n">db</span><span class="p">)</span>
@@ -233,7 +233,7 @@ <h1>Source code for pyne.dbgen.cinder</h1><div class="highlight"><pre>
 <span class="sd">        Directory with cinder.dat file.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="c"># Open the HDF5 File</span>
-    <span class="n">db</span> <span class="o">=</span> <span class="n">tb</span><span class="o">.</span><span class="n">openFile</span><span class="p">(</span><span class="n">nuc_data</span><span class="p">,</span> <span class="s">&#39;a&#39;</span><span class="p">)</span>
+    <span class="n">db</span> <span class="o">=</span> <span class="n">tb</span><span class="o">.</span><span class="n">openFile</span><span class="p">(</span><span class="n">nuc_data</span><span class="p">,</span> <span class="s">&#39;a&#39;</span><span class="p">,</span> <span class="n">filters</span><span class="o">=</span><span class="n">BASIC_FILTERS</span><span class="p">)</span>
 
     <span class="c"># Ensure that the appropriate file structure is present</span>
     <span class="n">_init_cinder</span><span class="p">(</span><span class="n">db</span><span class="p">)</span>
@@ -327,7 +327,7 @@ <h1>Source code for pyne.dbgen.cinder</h1><div class="highlight"><pre>
 <span class="sd">        Directory with cinder.dat file.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="c"># Open the HDF5 File</span>
-    <span class="n">db</span> <span class="o">=</span> <span class="n">tb</span><span class="o">.</span><span class="n">openFile</span><span class="p">(</span><span class="n">nuc_data</span><span class="p">,</span> <span class="s">&#39;a&#39;</span><span class="p">)</span>
+    <span class="n">db</span> <span class="o">=</span> <span class="n">tb</span><span class="o">.</span><span class="n">openFile</span><span class="p">(</span><span class="n">nuc_data</span><span class="p">,</span> <span class="s">&#39;a&#39;</span><span class="p">,</span> <span class="n">filters</span><span class="o">=</span><span class="n">BASIC_FILTERS</span><span class="p">)</span>
 
     <span class="c"># Ensure that the appropriate file structure is present</span>
     <span class="n">_init_cinder</span><span class="p">(</span><span class="n">db</span><span class="p">)</span>
@@ -416,7 +416,7 @@ <h1>Source code for pyne.dbgen.cinder</h1><div class="highlight"><pre>
 <span class="sd">        Directory with cinder.dat file.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="c"># Open the HDF5 File</span>
-    <span class="n">db</span> <span class="o">=</span> <span class="n">tb</span><span class="o">.</span><span class="n">openFile</span><span class="p">(</span><span class="n">nuc_data</span><span class="p">,</span> <span class="s">&#39;a&#39;</span><span class="p">)</span>
+    <span class="n">db</span> <span class="o">=</span> <span class="n">tb</span><span class="o">.</span><span class="n">openFile</span><span class="p">(</span><span class="n">nuc_data</span><span class="p">,</span> <span class="s">&#39;a&#39;</span><span class="p">,</span> <span class="n">filters</span><span class="o">=</span><span class="n">BASIC_FILTERS</span><span class="p">)</span>
 
     <span class="c"># Ensure that the appropriate file structure is present</span>
     <span class="n">_init_cinder</span><span class="p">(</span><span class="n">db</span><span class="p">)</span>
@@ -594,7 +594,7 @@ <h1>Source code for pyne.dbgen.cinder</h1><div class="highlight"><pre>
 <span class="sd">        Directory with cinder.dat file.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="c"># Open the HDF5 File</span>
-    <span class="n">db</span> <span class="o">=</span> <span class="n">tb</span><span class="o">.</span><span class="n">openFile</span><span class="p">(</span><span class="n">nuc_data</span><span class="p">,</span> <span class="s">&#39;a&#39;</span><span class="p">)</span>
+    <span class="n">db</span> <span class="o">=</span> <span class="n">tb</span><span class="o">.</span><span class="n">openFile</span><span class="p">(</span><span class="n">nuc_data</span><span class="p">,</span> <span class="s">&#39;a&#39;</span><span class="p">,</span> <span class="n">filters</span><span class="o">=</span><span class="n">BASIC_FILTERS</span><span class="p">)</span>
 
     <span class="c"># Ensure that the appropriate file structure is present</span>
     <span class="n">_init_cinder</span><span class="p">(</span><span class="n">db</span><span class="p">)</span>
@@ -683,7 +683,7 @@ <h1>Source code for pyne.dbgen.cinder</h1><div class="highlight"><pre>
 <span class="sd">        Directory with cinder.dat file.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="c"># Open the HDF5 File</span>
-    <span class="n">db</span> <span class="o">=</span> <span class="n">tb</span><span class="o">.</span><span class="n">openFile</span><span class="p">(</span><span class="n">nuc_data</span><span class="p">,</span> <span class="s">&#39;a&#39;</span><span class="p">)</span>
+    <span class="n">db</span> <span class="o">=</span> <span class="n">tb</span><span class="o">.</span><span class="n">openFile</span><span class="p">(</span><span class="n">nuc_data</span><span class="p">,</span> <span class="s">&#39;a&#39;</span><span class="p">,</span> <span class="n">filters</span><span class="o">=</span><span class="n">BASIC_FILTERS</span><span class="p">)</span>
 
     <span class="c"># Ensure that the appropriate file structure is present</span>
     <span class="n">_init_cinder</span><span class="p">(</span><span class="n">db</span><span class="p">)</span>
@@ -731,7 +731,7 @@ <h1>Source code for pyne.dbgen.cinder</h1><div class="highlight"><pre>
 <span class="sd">        Directory with cinder.dat file.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="c"># Open the HDF5 File</span>
-    <span class="n">db</span> <span class="o">=</span> <span class="n">tb</span><span class="o">.</span><span class="n">openFile</span><span class="p">(</span><span class="n">nuc_data</span><span class="p">,</span> <span class="s">&#39;a&#39;</span><span class="p">)</span>
+    <span class="n">db</span> <span class="o">=</span> <span class="n">tb</span><span class="o">.</span><span class="n">openFile</span><span class="p">(</span><span class="n">nuc_data</span><span class="p">,</span> <span class="s">&#39;a&#39;</span><span class="p">,</span> <span class="n">filters</span><span class="o">=</span><span class="n">BASIC_FILTERS</span><span class="p">)</span>
 
     <span class="c"># Ensure that the appropriate file structure is present</span>
     <span class="n">_init_cinder</span><span class="p">(</span><span class="n">db</span><span class="p">)</span>
@@ -804,7 +804,7 @@ <h1>Source code for pyne.dbgen.cinder</h1><div class="highlight"><pre>
 <span class="sd">        Directory with cinder.dat file.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="c"># Open the HDF5 File</span>
-    <span class="n">db</span> <span class="o">=</span> <span class="n">tb</span><span class="o">.</span><span class="n">openFile</span><span class="p">(</span><span class="n">nuc_data</span><span class="p">,</span> <span class="s">&#39;a&#39;</span><span class="p">)</span>
+    <span class="n">db</span> <span class="o">=</span> <span class="n">tb</span><span class="o">.</span><span class="n">openFile</span><span class="p">(</span><span class="n">nuc_data</span><span class="p">,</span> <span class="s">&#39;a&#39;</span><span class="p">,</span> <span class="n">filters</span><span class="o">=</span><span class="n">BASIC_FILTERS</span><span class="p">)</span>
 
     <span class="c"># Ensure that the appropriate file structure is present</span>
     <span class="n">_init_cinder</span><span class="p">(</span><span class="n">db</span><span class="p">)</span>
@@ -868,7 +868,7 @@ <h1>Source code for pyne.dbgen.cinder</h1><div class="highlight"><pre>
     <span class="sd">&quot;&quot;&quot;Controller function for adding cinder data.&quot;&quot;&quot;</span>
     <span class="n">nuc_data</span><span class="p">,</span> <span class="n">build_dir</span><span class="p">,</span> <span class="n">datapath</span> <span class="o">=</span> <span class="n">args</span><span class="o">.</span><span class="n">nuc_data</span><span class="p">,</span> <span class="n">args</span><span class="o">.</span><span class="n">build_dir</span><span class="p">,</span> <span class="n">args</span><span class="o">.</span><span class="n">datapath</span>
 
-    <span class="k">with</span> <span class="n">tb</span><span class="o">.</span><span class="n">openFile</span><span class="p">(</span><span class="n">nuc_data</span><span class="p">,</span> <span class="s">&#39;a&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
+    <span class="k">with</span> <span class="n">tb</span><span class="o">.</span><span class="n">openFile</span><span class="p">(</span><span class="n">nuc_data</span><span class="p">,</span> <span class="s">&#39;a&#39;</span><span class="p">,</span> <span class="n">filters</span><span class="o">=</span><span class="n">BASIC_FILTERS</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
         <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">root</span><span class="p">,</span> <span class="s">&#39;neutron&#39;</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">root</span><span class="o">.</span><span class="n">neutron</span><span class="p">,</span> <span class="s">&#39;cinder_xs&#39;</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">root</span><span class="o">.</span><span class="n">neutron</span><span class="p">,</span> <span class="s">&#39;cinder_fission_products&#39;</span><span class="p">):</span>
             <span class="k">return</span>