Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jswhit committed Jan 17, 2022
1 parent 9a4a885 commit 0703c6b
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

<h2>Contents</h2>
<ul>
<li><a href="#version-158">Version 1.5.8</a></li>
<li><a href="#version-160">Version 1.6.0</a></li>
</ul></li>
<li><a href="#introduction">Introduction</a>
<ul>
Expand Down Expand Up @@ -456,7 +456,7 @@ <h2>API Documentation</h2>
<h1 class="modulename">
netCDF4 </h1>

<div class="docstring"><h2 id="version-158">Version 1.5.8</h2>
<div class="docstring"><h2 id="version-160">Version 1.6.0</h2>

<h1 id="introduction">Introduction</h1>

Expand Down Expand Up @@ -1595,7 +1595,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="&#109;&#97;&#105;&#108;&#116;&#x6f;&#x3a;&#x6a;&#101;f&#102;&#x72;&#x65;&#x79;&#x2e;&#115;&#x2e;&#119;&#104;&#x69;&#116;&#97;&#x6b;&#x65;&#x72;&#x40;&#110;&#111;&#97;&#x61;&#x2e;&#x67;&#x6f;&#x76;">&#x6a;&#101;f&#102;&#x72;&#x65;&#x79;&#x2e;&#115;&#x2e;&#119;&#104;&#x69;&#116;&#97;&#x6b;&#x65;&#x72;&#x40;&#110;&#111;&#97;&#x61;&#x2e;&#x67;&#x6f;&#x76;</a></p>
<p><strong>contact</strong>: Jeffrey Whitaker <a href="&#109;a&#105;&#x6c;&#116;&#x6f;&#x3a;&#x6a;&#x65;&#x66;&#102;r&#101;y.&#115;&#x2e;&#119;&#x68;&#105;&#116;&#97;&#107;&#x65;&#x72;&#64;&#110;&#111;&#x61;&#x61;&#x2e;&#x67;&#x6f;&#118;">&#x6a;&#x65;&#x66;&#102;r&#101;y.&#115;&#x2e;&#119;&#x68;&#105;&#116;&#97;&#107;&#x65;&#x72;&#64;&#110;&#111;&#x61;&#x61;&#x2e;&#x67;&#x6f;&#118;</a></p>

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

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

<p><strong><code>mode</code></strong>: access mode. <code>r</code> means read-only; no data can be
modified. <code>w</code> means write; a new file is created, an existing file with
the same name is deleted. <code>a</code> and <code>r+</code> mean append (in analogy with
serial files); an existing file is opened for reading and writing.
the same name is deleted. 'x' means write, but fail if an existing
file with the same name already exists. <code>a</code> and <code>r+</code> mean append;
an existing file is opened for reading and writing, if
file does not exist already, one is created.
Appending <code>s</code> to modes <code>r</code>, <code>w</code>, <code>r+</code> or <code>a</code> will enable unbuffered shared
access to <code>NETCDF3_CLASSIC</code>, <code>NETCDF3_64BIT_OFFSET</code> or
<code>NETCDF3_64BIT_DATA</code> formatted files.
Expand All @@ -1737,7 +1739,8 @@ <h2 id="in-memory-diskless-datasets">In-memory (diskless) Datasets</h2>

<p><strong><code>clobber</code></strong>: if <code>True</code> (default), opening a file with <code>mode='w'</code>
will clobber an existing file with the same name. if <code>False</code>, an
exception will be raised if a file with the same name already exists.</p>
exception will be raised if a file with the same name already exists.
mode='x' is identical to mode='w' with clobber=False.</p>

<p><strong><code>format</code></strong>: underlying file format (one of <code>'NETCDF4',
'NETCDF4_CLASSIC', 'NETCDF3_CLASSIC'</code>, <code>'NETCDF3_64BIT_OFFSET'</code> or
Expand Down Expand Up @@ -2062,8 +2065,9 @@ <h2 id="in-memory-diskless-datasets">In-memory (diskless) Datasets</h2>
<p>Data from netCDF variables is presented to python as numpy arrays with
the corresponding data type.</p>

<p><code><a href="#Dataset.dimensions">dimensions</a></code> must be a tuple containing dimension names (strings) that
have been defined previously using <code><a href="#Dataset.createDimension">Dataset.createDimension</a></code>. The default value
<p><code><a href="#Dataset.dimensions">dimensions</a></code> must be a tuple containing <code><a href="#Dimension">Dimension</a></code> instances and/or
dimension names (strings) that have been defined
previously using <code><a href="#Dataset.createDimension">Dataset.createDimension</a></code>. The default value
is an empty tuple, which means the variable is a scalar.</p>

<p>If the optional keyword <code>zlib</code> is <code>True</code>, the data will be compressed in
Expand Down Expand Up @@ -2813,7 +2817,7 @@ <h2 id="in-memory-diskless-datasets">In-memory (diskless) Datasets</h2>
(for a variable-length string array). Numpy string and unicode datatypes with
length greater than one are aliases for <code>str</code>.</p>

<p><strong><code><a href="#Variable.dimensions">dimensions</a></code></strong>: a tuple containing the variable's dimension names
<p><strong><code><a href="#Variable.dimensions">dimensions</a></code></strong>: a tuple containing the variable's Dimension instances
(defined previously with <code>createDimension</code>). Default is an empty tuple
which means the variable is a scalar (and therefore has no dimensions).</p>

Expand Down

0 comments on commit 0703c6b

Please sign in to comment.