Adding updated documentation

docs/datasets.html

@@ -236,7 +236,7 @@
 
 <dl class="class">
 <dt id="pyconform.datasets.DimensionDesc">
-<em class="property">class </em><code class="descclassname">pyconform.datasets.</code><code class="descname">DimensionDesc</code><span class="sig-paren">(</span><em>name</em>, <em>size=None</em>, <em>unlimited=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyconform/datasets.html#DimensionDesc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyconform.datasets.DimensionDesc" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="descclassname">pyconform.datasets.</code><code class="descname">DimensionDesc</code><span class="sig-paren">(</span><em>name</em>, <em>size=None</em>, <em>unlimited=False</em>, <em>stringlen=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyconform/datasets.html#DimensionDesc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyconform.datasets.DimensionDesc" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
 <p>Descriptor for a dimension in a DatasetDesc</p>
 <p>Contains the name of the dimensions, its size, and whether the dimension is limited or
@@ -273,6 +273,12 @@
 <dd><p>Numeric size of the dimension (if set)</p>
 </dd></dl>
 
+<dl class="attribute">
+<dt id="pyconform.datasets.DimensionDesc.stringlen">
+<code class="descname">stringlen</code><a class="headerlink" href="#pyconform.datasets.DimensionDesc.stringlen" title="Permalink to this definition">¶</a></dt>
+<dd><p>Boolean indicating whether the dimension represents a string length or not</p>
+</dd></dl>
+
 <dl class="staticmethod">
 <dt id="pyconform.datasets.DimensionDesc.unique">
 <em class="property">static </em><code class="descname">unique</code><span class="sig-paren">(</span><em>descs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyconform/datasets.html#DimensionDesc.unique"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyconform.datasets.DimensionDesc.unique" title="Permalink to this definition">¶</a></dt>
@@ -415,16 +421,11 @@
 </ol>
 </dd>
 </dl>
-<dl class="attribute">
-<dt id="pyconform.datasets.OutputDatasetDesc.t">
-<code class="descname">t</code><em class="property"> = 'f8'</em><a class="headerlink" href="#pyconform.datasets.OutputDatasetDesc.t" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
 </dd></dl>
 
 <dl class="class">
 <dt id="pyconform.datasets.VariableDesc">
-<em class="property">class </em><code class="descclassname">pyconform.datasets.</code><code class="descname">VariableDesc</code><span class="sig-paren">(</span><em>name</em>, <em>datatype='float32'</em>, <em>dimensions=()</em>, <em>definition=None</em>, <em>attributes={}</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyconform/datasets.html#VariableDesc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyconform.datasets.VariableDesc" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="descclassname">pyconform.datasets.</code><code class="descname">VariableDesc</code><span class="sig-paren">(</span><em>name</em>, <em>datatype='float'</em>, <em>dimensions=()</em>, <em>definition=None</em>, <em>attributes={}</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyconform/datasets.html#VariableDesc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyconform.datasets.VariableDesc" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
 <p>Descriptor for a variable in a dataset</p>
 <p>Contains the variable name, string datatype, dimensions tuple, attributes dictionary,
@@ -460,6 +461,12 @@
 <dd><p>Dictionary of dimension descriptors for dimensions on which the variable depends</p>
 </dd></dl>
 
+<dl class="attribute">
+<dt id="pyconform.datasets.VariableDesc.dtype">
+<code class="descname">dtype</code><a class="headerlink" href="#pyconform.datasets.VariableDesc.dtype" title="Permalink to this definition">¶</a></dt>
+<dd><p>NumPy dtype of the variable data</p>
+</dd></dl>
+
 <dl class="attribute">
 <dt id="pyconform.datasets.VariableDesc.files">
 <code class="descname">files</code><a class="headerlink" href="#pyconform.datasets.VariableDesc.files" title="Permalink to this definition">¶</a></dt>

docs/flownodes.html

@@ -262,7 +262,7 @@
 
 <dl class="class">
 <dt id="pyconform.flownodes.ValidateNode">
-<em class="property">class </em><code class="descclassname">pyconform.flownodes.</code><code class="descname">ValidateNode</code><span class="sig-paren">(</span><em>label</em>, <em>dnode</em>, <em>units=None</em>, <em>dimensions=None</em>, <em>dtype=None</em>, <em>attributes={}</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyconform/flownodes.html#ValidateNode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyconform.flownodes.ValidateNode" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="descclassname">pyconform.flownodes.</code><code class="descname">ValidateNode</code><span class="sig-paren">(</span><em>label</em>, <em>dnode</em>, <em>dimensions=None</em>, <em>dtype=None</em>, <em>attributes={}</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyconform/flownodes.html#ValidateNode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyconform.flownodes.ValidateNode" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="#pyconform.flownodes.FlowNode" title="pyconform.flownodes.FlowNode"><code class="xref py py-class docutils literal"><span class="pre">pyconform.flownodes.FlowNode</span></code></a></p>
 <p>FlowNode class to validate input data from a neighboring FlowNode</p>
 <p>The ValidateNode takes additional attributes in its initializer that can effect the
@@ -348,6 +348,34 @@
 
 </dd></dl>
 
+<dl class="function">
+<dt id="pyconform.flownodes.iter_bfs">
+<code class="descclassname">pyconform.flownodes.</code><code class="descname">iter_bfs</code><span class="sig-paren">(</span><em>node</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyconform/flownodes.html#iter_bfs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyconform.flownodes.iter_bfs" title="Permalink to this definition">¶</a></dt>
+<dd><p>Iterate through graph of FlowNodes from a starting node using a Breadth-First Search</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>node</strong> (<a class="reference internal" href="#pyconform.flownodes.FlowNode" title="pyconform.flownodes.FlowNode"><em>FlowNode</em></a>) – the starting node from where to begin iterating</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyconform.flownodes.iter_dfs">
+<code class="descclassname">pyconform.flownodes.</code><code class="descname">iter_dfs</code><span class="sig-paren">(</span><em>node</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyconform/flownodes.html#iter_dfs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyconform.flownodes.iter_dfs" title="Permalink to this definition">¶</a></dt>
+<dd><p>Iterate through graph of FlowNodes from a starting node using a Depth-First Search</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>node</strong> (<a class="reference internal" href="#pyconform.flownodes.FlowNode" title="pyconform.flownodes.FlowNode"><em>FlowNode</em></a>) – the starting node from where to begin iterating</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
 </div>
 
 

docs/functions.html

@@ -198,7 +198,7 @@
 
 <dl class="class">
 <dt id="pyconform.functions.ChangeUnitsFunction">
-<em class="property">class </em><code class="descclassname">pyconform.functions.</code><code class="descname">ChangeUnitsFunction</code><span class="sig-paren">(</span><em>data</em>, <em>units=1</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyconform/functions.html#ChangeUnitsFunction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyconform.functions.ChangeUnitsFunction" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="descclassname">pyconform.functions.</code><code class="descname">ChangeUnitsFunction</code><span class="sig-paren">(</span><em>data</em>, <em>units=None</em>, <em>refdate=None</em>, <em>calendar=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyconform/functions.html#ChangeUnitsFunction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyconform.functions.ChangeUnitsFunction" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="#pyconform.functions.Function" title="pyconform.functions.Function"><code class="xref py py-class docutils literal"><span class="pre">pyconform.functions.Function</span></code></a></p>
 <dl class="attribute">
 <dt id="pyconform.functions.ChangeUnitsFunction.key">

docs/genindex.html

@@ -211,13 +211,19 @@ <h2 id="C">C</h2>
       <li><a href="datasets.html#pyconform.datasets.VariableDesc.calendar">calendar() (pyconform.datasets.VariableDesc method)</a>
 </li>
       <li><a href="datasets.html#pyconform.datasets.VariableDesc.cfunits">cfunits() (pyconform.datasets.VariableDesc method)</a>
+</li>
+      <li><a href="functions.html#pyconform.functions.ChangeUnitsFunction">ChangeUnitsFunction (class in pyconform.functions)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="functions.html#pyconform.functions.ChangeUnitsFunction">ChangeUnitsFunction (class in pyconform.functions)</a>
+      <li><a href="physarray.html#pyconform.physarray.CharArray">CharArray (class in pyconform.physarray)</a>
 </li>
-      <li><a href="physarray.html#pyconform.physarray.PhysArray.convert">convert() (pyconform.physarray.PhysArray method)</a>
+      <li><a href="physarray.html#pyconform.physarray.CharArray.convert">convert() (pyconform.physarray.CharArray method)</a>
+
+      <ul>
+        <li><a href="physarray.html#pyconform.physarray.PhysArray.convert">(pyconform.physarray.PhysArray method)</a>
 </li>
+      </ul></li>
   </ul></td>
 </tr></table>
 
@@ -240,8 +246,6 @@ <h2 id="D">D</h2>
 </li>
       <li><a href="datasets.html#pyconform.datasets.DimensionDesc">DimensionDesc (class in pyconform.datasets)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="datasets.html#pyconform.datasets.DatasetDesc.dimensions">dimensions (pyconform.datasets.DatasetDesc attribute)</a>
 
       <ul>
@@ -254,13 +258,17 @@ <h2 id="D">D</h2>
         <li><a href="physarray.html#pyconform.physarray.PhysArray.dimensions">(pyconform.physarray.PhysArray attribute)</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="physarray.html#pyconform.physarray.DimensionsError">DimensionsError</a>
 </li>
       <li><a href="flownodes.html#pyconform.flownodes.WriteNode.disable_history">disable_history() (pyconform.flownodes.WriteNode method)</a>
 </li>
       <li><a href="functions.html#pyconform.functions.DivisionOperator">DivisionOperator (class in pyconform.functions)</a>
 </li>
       <li><a href="physarray.html#pyconform.physarray.PhysArray.down">down() (pyconform.physarray.PhysArray method)</a>
+</li>
+      <li><a href="datasets.html#pyconform.datasets.VariableDesc.dtype">dtype (pyconform.datasets.VariableDesc attribute)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -323,6 +331,8 @@ <h2 id="G">G</h2>
       <li><a href="physarray.html#pyconform.physarray.getdata">getdata() (in module pyconform.physarray)</a>
 </li>
       <li><a href="physarray.html#pyconform.physarray.getdimensions">getdimensions() (in module pyconform.physarray)</a>
+</li>
+      <li><a href="physarray.html#pyconform.physarray.getdtype">getdtype() (in module pyconform.physarray)</a>
 </li>
       <li><a href="physarray.html#pyconform.physarray.getmask">getmask() (in module pyconform.physarray)</a>
 </li>
@@ -331,6 +341,8 @@ <h2 id="G">G</h2>
       <li><a href="physarray.html#pyconform.physarray.getname">getname() (in module pyconform.physarray)</a>
 </li>
       <li><a href="physarray.html#pyconform.physarray.getpositive">getpositive() (in module pyconform.physarray)</a>
+</li>
+      <li><a href="physarray.html#pyconform.physarray.getshape">getshape() (in module pyconform.physarray)</a>
 </li>
       <li><a href="physarray.html#pyconform.physarray.getunits">getunits() (in module pyconform.physarray)</a>
 </li>
@@ -346,15 +358,25 @@ <h2 id="I">I</h2>
 </li>
       <li><a href="datasets.html#pyconform.datasets.InputDatasetDesc">InputDatasetDesc (class in pyconform.datasets)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="flownodes.html#pyconform.flownodes.FlowNode.inputs">inputs (pyconform.flownodes.FlowNode attribute)</a>
 </li>
-      <li><a href="physarray.html#pyconform.physarray.PhysArray.invert">invert() (pyconform.physarray.PhysArray method)</a>
+      <li><a href="physarray.html#pyconform.physarray.CharArray.invert">invert() (pyconform.physarray.CharArray method)</a>
+
+      <ul>
+        <li><a href="physarray.html#pyconform.physarray.PhysArray.invert">(pyconform.physarray.PhysArray method)</a>
 </li>
+      </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="functions.html#pyconform.functions.is_constant">is_constant() (in module pyconform.functions)</a>
 </li>
       <li><a href="datasets.html#pyconform.datasets.DimensionDesc.is_set">is_set() (pyconform.datasets.DimensionDesc method)</a>
+</li>
+      <li><a href="physarray.html#pyconform.physarray.ischartype">ischartype() (in module pyconform.physarray)</a>
+</li>
+      <li><a href="flownodes.html#pyconform.flownodes.iter_bfs">iter_bfs() (in module pyconform.flownodes)</a>
+</li>
+      <li><a href="flownodes.html#pyconform.flownodes.iter_dfs">iter_dfs() (in module pyconform.flownodes)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -425,6 +447,8 @@ <h2 id="M">M</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="flownodes.html#pyconform.flownodes.MapNode">MapNode (class in pyconform.flownodes)</a>
+</li>
+      <li><a href="physarray.html#pyconform.physarray.PhysArray.mean">mean() (pyconform.physarray.PhysArray method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -500,14 +524,18 @@ <h2 id="P">P</h2>
 </li>
       <li><a href="physarray.html#pyconform.physarray.PhysArray">PhysArray (class in pyconform.physarray)</a>
 </li>
-      <li><a href="physarray.html#pyconform.physarray.PhysArray.positive">positive (pyconform.physarray.PhysArray attribute)</a>
+      <li><a href="physarray.html#pyconform.physarray.CharArray.positive">positive (pyconform.physarray.CharArray attribute)</a>
+
+      <ul>
+        <li><a href="physarray.html#pyconform.physarray.PhysArray.positive">(pyconform.physarray.PhysArray attribute)</a>
 </li>
+      </ul></li>
       <li><a href="functions.html#pyconform.functions.PositiveDownFunction">PositiveDownFunction (class in pyconform.functions)</a>
-</li>
-      <li><a href="functions.html#pyconform.functions.PositiveUpFunction">PositiveUpFunction (class in pyconform.functions)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="functions.html#pyconform.functions.PositiveUpFunction">PositiveUpFunction (class in pyconform.functions)</a>
+</li>
       <li><a href="functions.html#pyconform.functions.PowerOperator">PowerOperator (class in pyconform.functions)</a>
 </li>
       <li><a href="pyconform.html#module-pyconform">pyconform (module)</a>
@@ -545,10 +573,16 @@ <h2 id="S">S</h2>
       <li><a href="datasets.html#pyconform.datasets.DimensionDesc.size">size (pyconform.datasets.DimensionDesc attribute)</a>
 </li>
       <li><a href="functions.html#pyconform.functions.SquareRootFunction">SquareRootFunction (class in pyconform.functions)</a>
+</li>
+      <li><a href="physarray.html#pyconform.physarray.CharArray.stretch">stretch() (pyconform.physarray.CharArray method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="datasets.html#pyconform.datasets.DimensionDesc.stringlen">stringlen (pyconform.datasets.DimensionDesc attribute)</a>
+</li>
       <li><a href="functions.html#pyconform.functions.SubtractionOperator">SubtractionOperator (class in pyconform.functions)</a>
+</li>
+      <li><a href="physarray.html#pyconform.physarray.PhysArray.sum">sum() (pyconform.physarray.PhysArray method)</a>
 </li>
       <li><a href="flownodes.html#pyconform.flownodes.EvalNode.sumlike_dimensions">sumlike_dimensions (pyconform.flownodes.EvalNode attribute)</a>
 
@@ -562,12 +596,12 @@ <h2 id="S">S</h2>
 <h2 id="T">T</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="datasets.html#pyconform.datasets.OutputDatasetDesc.t">t (pyconform.datasets.OutputDatasetDesc attribute)</a>
-</li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="physarray.html#pyconform.physarray.PhysArray.transpose">transpose() (pyconform.physarray.PhysArray method)</a>
+      <li><a href="physarray.html#pyconform.physarray.CharArray.transpose">transpose() (pyconform.physarray.CharArray method)</a>
+
+      <ul>
+        <li><a href="physarray.html#pyconform.physarray.PhysArray.transpose">(pyconform.physarray.PhysArray method)</a>
 </li>
+      </ul></li>
   </ul></td>
 </tr></table>
 
@@ -582,12 +616,16 @@ <h2 id="U">U</h2>
         <li><a href="datasets.html#pyconform.datasets.VariableDesc.unique">(pyconform.datasets.VariableDesc static method)</a>
 </li>
       </ul></li>
-      <li><a href="physarray.html#pyconform.physarray.PhysArray.units">units (pyconform.physarray.PhysArray attribute)</a>
-</li>
-      <li><a href="datasets.html#pyconform.datasets.VariableDesc.units">units() (pyconform.datasets.VariableDesc method)</a>
+      <li><a href="physarray.html#pyconform.physarray.CharArray.units">units (pyconform.physarray.CharArray attribute)</a>
+
+      <ul>
+        <li><a href="physarray.html#pyconform.physarray.PhysArray.units">(pyconform.physarray.PhysArray attribute)</a>
 </li>
+      </ul></li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="datasets.html#pyconform.datasets.VariableDesc.units">units() (pyconform.datasets.VariableDesc method)</a>
+</li>
       <li><a href="physarray.html#pyconform.physarray.UnitsError">UnitsError</a>
 </li>
       <li><a href="flownodes.html#pyconform.flownodes.UnitsWarning">UnitsWarning</a>