Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jswhit committed Feb 13, 2021
1 parent 5d071b8 commit a901113
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -487,11 +487,12 @@ <h2 id="download">Download</h2>
<h2 id="requires">Requires</h2>

<ul>
<li>Python 3.6 or later.</li>
<li><a href="http://numpy.scipy.org">numpy array module</a>, version 1.10.0 or later.</li>
<li><a href="http://cython.org">Cython</a>, version 0.21 or later.</li>
<li><a href="https://pypi.python.org/pypi/setuptools">setuptools</a>, version 18.0 or
later.</li>
<li>The HDF5 C library version 1.8.4-patch1 or higher (1.8.x recommended)
<li>The HDF5 C library version 1.8.4-patch1 or higher
from <a href="ftp://ftp.hdfgroup.org/HDF5/current/src"></a>.
<strong><em>netCDF version 4.4.1 or higher is recommended if using HDF5 1.10.x -
otherwise resulting files may be unreadable by clients using earlier
Expand Down Expand Up @@ -1616,7 +1617,7 @@ <h2 id="in-memory-diskless-datasets">In-memory (diskless) Datasets</h2>
the parallel IO example, which is in <code>examples/mpi_example.py</code>.
Unit tests are in the <code>test</code> directory.</p>

<p><strong>contact</strong>: Jeffrey Whitaker <a href="&#x6d;&#x61;i&#x6c;&#116;&#x6f;&#58;j&#x65;f&#102;r&#101;y&#46;&#115;&#46;&#x77;&#x68;i&#x74;&#x61;k&#x65;&#114;&#x40;&#x6e;&#111;&#x61;&#x61;&#46;g&#x6f;&#118;">j&#x65;f&#102;r&#101;y&#46;&#115;&#46;&#x77;&#x68;i&#x74;&#x61;k&#x65;&#114;&#x40;&#x6e;&#111;&#x61;&#x61;&#46;g&#x6f;&#118;</a></p>
<p><strong>contact</strong>: Jeffrey Whitaker <a href="&#109;&#97;&#105;&#x6c;&#116;&#x6f;&#x3a;&#x6a;&#101;ff&#114;&#x65;&#121;&#x2e;&#x73;&#x2e;&#119;&#x68;&#105;&#116;&#x61;&#107;&#101;&#114;&#64;n&#x6f;&#x61;a.&#x67;&#111;v">&#x6a;&#101;ff&#114;&#x65;&#121;&#x2e;&#x73;&#x2e;&#119;&#x68;&#105;&#116;&#x61;&#107;&#101;&#114;&#64;n&#x6f;&#x61;a.&#x67;&#111;v</a></p>

<p><strong>copyright</strong>: 2008 by Jeffrey Whitaker.</p>

Expand Down Expand Up @@ -2541,8 +2542,8 @@ <h2 id="in-memory-diskless-datasets">In-memory (diskless) Datasets</h2>

<div class="docstring"><p><strong><code>fromcdl(cdlfilename, ncfilename=None, mode='a',format='NETCDF4')</code></strong></p>

<p>call ncgen via subprocess to create Dataset from <a href="https://www.unidata.ucar.edu/software/netcdf/docs/netcdf_utilities_guide.html#cdl_guide">CDL</a>
text representation.</p>
<p>call <code>ncgen</code> via subprocess to create Dataset from <a href="https://www.unidata.ucar.edu/software/netcdf/docs/netcdf_utilities_guide.html#cdl_guide">CDL</a>
text representation. Requires <code>ncgen</code> to be installed and in <code>$PATH</code>.</p>

<p><strong><code>cdlfilename</code></strong>: CDL file.</p>

Expand Down Expand Up @@ -2571,12 +2572,12 @@ <h2 id="in-memory-diskless-datasets">In-memory (diskless) Datasets</h2>

<div class="docstring"><p><strong><code>tocdl(self, coordvars=False, data=False, outfile=None)</code></strong></p>

<p>call ncdump via subprocess to create <a href="https://www.unidata.ucar.edu/software/netcdf/docs/netcdf_utilities_guide.html#cdl_guide">CDL</a>
text representation of Dataset</p>
<p>call <code>ncdump</code> via subprocess to create <a href="https://www.unidata.ucar.edu/software/netcdf/docs/netcdf_utilities_guide.html#cdl_guide">CDL</a>
text representation of Dataset. Requires <code>ncdump</code> to be installed and in <code>$PATH</code>.</p>

<p><strong><code>coordvars</code></strong>: if True, write out coordinate variable data (Default False).</p>
<p><strong><code>coordvars</code></strong>: include coordinate variable data (via <code>ncdump -c</code>). Default False</p>

<p><strong><code>data</code></strong>: if True, write out all variable data (Default False).</p>
<p><strong><code>data</code></strong>: if True, write out variable data (Default False).</p>

<p><strong><code>outfile</code></strong>: If not None, file to output ncdump to. Default is to return a string.</p>
</div>
Expand Down

0 comments on commit a901113

Please sign in to comment.