[Git][debian-gis-team/netcdf4-python][upstream] New upstream version 1.5.0.1
Bas Couwenberg
gitlab at salsa.debian.org
Tue Apr 2 06:27:43 BST 2019
Bas Couwenberg pushed to branch upstream at Debian GIS Project / netcdf4-python
Commits:
53bbcc5c by Bas Couwenberg at 2019-04-02T05:07:46Z
New upstream version 1.5.0.1
- - - - -
5 changed files:
- Changelog
- README.md
- docs/netCDF4/index.html
- netCDF4/_netCDF4.pyx
- setup.py
Changes:
=====================================
Changelog
=====================================
@@ -1,3 +1,10 @@
+ version 1.5.0.1 (tag v1.5.0.1rel)
+==================================
+ * binary wheels for linux and macosx rebuilt against netcdf-c 4.6.3 (instead
+ of 4.4.1.1).
+ * add read-shared mode (mode='rs'). Significantly speeds up reads of NETCDF3
+ files (pull request #902).
+
version 1.5.0 (tag v1.5.0rel)
===============================
* added support for parallel IO in the classic netcdf-3 formats through the
=====================================
README.md
=====================================
@@ -5,10 +5,14 @@
[](https://ci.appveyor.com/project/jswhit/netcdf4-python/branch/master)
[](http://python.org/pypi/netCDF4)
[](https://anaconda.org/conda-forge/netCDF4)
-[](https://doi.org/10.5281/zenodo.2592291)
+[](https://doi.org/10.5281/zenodo.2592290)
## News
For details on the latest updates, see the [Changelog](https://github.com/Unidata/netcdf4-python/blob/master/Changelog).
+
+04/02/2019: Version [1.5.0.1](https://pypi.python.org/pypi/netCDF4/1.5.0.1) released. Binary wheels for macos x
+and linux rebuilt with netcdf-c 4.6.3 (instead of 4.4.1.1). Added read-shared capability for faster reads
+of NETCDF3 files (mode='rs').
03/24/2019: Version [1.5.0](https://pypi.python.org/pypi/netCDF4/1.5.0) released. Parallel IO support for classic
file formats added using the pnetcdf library (contribution from Lars Pastewka, [pull request #897](https://github.com/Unidata/netcdf4-python/pull/897)).
=====================================
docs/netCDF4/index.html
=====================================
@@ -4,7 +4,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<title>netCDF4 API documentation</title>
- <meta name="description" content="Version 1.4.3
+ <meta name="description" content="Version 1.5.0
-------------
- - -
@@ -1174,8 +1174,6 @@ table {
<ul>
- <li class="mono"><a href="#netCDF4.MFDataset.__init__">__init__</a></li>
- <li class="mono"><a href="#netCDF4.MFDataset.close">close</a></li>
<li class="mono"><a href="#netCDF4.MFDataset.createCompoundType">createCompoundType</a></li>
<li class="mono"><a href="#netCDF4.MFDataset.createDimension">createDimension</a></li>
<li class="mono"><a href="#netCDF4.MFDataset.createEnumType">createEnumType</a></li>
@@ -1187,7 +1185,6 @@ table {
<li class="mono"><a href="#netCDF4.MFDataset.get_variables_by_attributes">get_variables_by_attributes</a></li>
<li class="mono"><a href="#netCDF4.MFDataset.getncattr">getncattr</a></li>
<li class="mono"><a href="#netCDF4.MFDataset.isopen">isopen</a></li>
- <li class="mono"><a href="#netCDF4.MFDataset.ncattrs">ncattrs</a></li>
<li class="mono"><a href="#netCDF4.MFDataset.renameAttribute">renameAttribute</a></li>
<li class="mono"><a href="#netCDF4.MFDataset.renameDimension">renameDimension</a></li>
<li class="mono"><a href="#netCDF4.MFDataset.renameGroup">renameGroup</a></li>
@@ -1204,6 +1201,9 @@ table {
<li class="mono"><a href="#netCDF4.MFDataset.setncattr_string">setncattr_string</a></li>
<li class="mono"><a href="#netCDF4.MFDataset.setncatts">setncatts</a></li>
<li class="mono"><a href="#netCDF4.MFDataset.sync">sync</a></li>
+ <li class="mono"><a href="#netCDF4.MFDataset.__init__">__init__</a></li>
+ <li class="mono"><a href="#netCDF4.MFDataset.close">close</a></li>
+ <li class="mono"><a href="#netCDF4.MFDataset.ncattrs">ncattrs</a></li>
</ul>
</li>
@@ -1280,7 +1280,7 @@ table {
<header id="section-intro">
<h1 class="title"><span class="name">netCDF4</span> module</h1>
- <h2>Version 1.4.3</h2>
+ <h2>Version 1.5.0</h2>
<hr />
<h1>Introduction</h1>
<p>netcdf4-python is a Python interface to the netCDF C library.</p>
@@ -2621,7 +2621,7 @@ the user.</p></div>
<h3>Ancestors (in MRO)</h3>
<ul class="class_list">
<li><a href="#netCDF4.CompoundType">CompoundType</a></li>
- <li>builtins.object</li>
+ <li>__builtin__.object</li>
</ul>
<h3>Class variables</h3>
<div class="item">
@@ -2752,7 +2752,7 @@ strings.</p></div>
<h3>Ancestors (in MRO)</h3>
<ul class="class_list">
<li><a href="#netCDF4.Dataset">Dataset</a></li>
- <li>builtins.object</li>
+ <li>__builtin__.object</li>
</ul>
<h3>Class variables</h3>
<div class="item">
@@ -3674,7 +3674,7 @@ determine if the dimension is unlimited.</p>
<h3>Ancestors (in MRO)</h3>
<ul class="class_list">
<li><a href="#netCDF4.Dimension">Dimension</a></li>
- <li>builtins.object</li>
+ <li>__builtin__.object</li>
</ul>
<h3>Class variables</h3>
<div class="item">
@@ -3772,7 +3772,7 @@ the user.</p></div>
<h3>Ancestors (in MRO)</h3>
<ul class="class_list">
<li><a href="#netCDF4.EnumType">EnumType</a></li>
- <li>builtins.object</li>
+ <li>__builtin__.object</li>
</ul>
<h3>Class variables</h3>
<div class="item">
@@ -3860,15 +3860,22 @@ to a <a href="#netCDF4.Group"><code>Group</code></a> instance (except the <code>
<ul class="class_list">
<li><a href="#netCDF4.Group">Group</a></li>
<li><a href="#netCDF4.Dataset">Dataset</a></li>
- <li>builtins.object</li>
+ <li>__builtin__.object</li>
</ul>
<h3>Class variables</h3>
<div class="item">
<p id="netCDF4.Group.cmptypes" class="name">var <span class="ident">cmptypes</span></p>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.cmptypes">cmptypes</a></code>
+ </p>
+ <div class="desc inherited"><p>The <code>cmptypes</code> dictionary maps the names of
+compound types defined for the <a href="#netCDF4.Group"><code>Group</code></a> or <a href="#netCDF4.Dataset"><code>Dataset</code></a> to instances of the
+<a href="#netCDF4.CompoundType"><code>CompoundType</code></a> class.</p></div>
<div class="source_cont">
</div>
@@ -3876,9 +3883,16 @@ to a <a href="#netCDF4.Group"><code>Group</code></a> instance (except the <code>
<div class="item">
<p id="netCDF4.Group.data_model" class="name">var <span class="ident">data_model</span></p>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.data_model">data_model</a></code>
+ </p>
+ <div class="desc inherited"><p><code>data_model</code> describes the netCDF
+data model version, one of <code>NETCDF3_CLASSIC</code>, <code>NETCDF4</code>,
+<code>NETCDF4_CLASSIC</code>, <code>NETCDF3_64BIT_OFFSET</code> or <code>NETCDF3_64BIT_DATA</code>.</p></div>
<div class="source_cont">
</div>
@@ -3886,9 +3900,16 @@ to a <a href="#netCDF4.Group"><code>Group</code></a> instance (except the <code>
<div class="item">
<p id="netCDF4.Group.dimensions" class="name">var <span class="ident">dimensions</span></p>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.dimensions">dimensions</a></code>
+ </p>
+ <div class="desc inherited"><p>The <code>dimensions</code> dictionary maps the names of
+dimensions defined for the <a href="#netCDF4.Group"><code>Group</code></a> or <a href="#netCDF4.Dataset"><code>Dataset</code></a> to instances of the
+<a href="#netCDF4.Dimension"><code>Dimension</code></a> class.</p></div>
<div class="source_cont">
</div>
@@ -3896,9 +3917,18 @@ to a <a href="#netCDF4.Group"><code>Group</code></a> instance (except the <code>
<div class="item">
<p id="netCDF4.Group.disk_format" class="name">var <span class="ident">disk_format</span></p>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.disk_format">disk_format</a></code>
+ </p>
+ <div class="desc inherited"><p><code>disk_format</code> describes the underlying
+file format, one of <code>NETCDF3</code>, <code>HDF5</code>, <code>HDF4</code>,
+<code>PNETCDF</code>, <code>DAP2</code>, <code>DAP4</code> or <code>UNDEFINED</code>. Only available if using
+netcdf C library version >= 4.3.1, otherwise will always return
+<code>UNDEFINED</code>.</p></div>
<div class="source_cont">
</div>
@@ -3906,9 +3936,16 @@ to a <a href="#netCDF4.Group"><code>Group</code></a> instance (except the <code>
<div class="item">
<p id="netCDF4.Group.enumtypes" class="name">var <span class="ident">enumtypes</span></p>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.enumtypes">enumtypes</a></code>
+ </p>
+ <div class="desc inherited"><p>The <code>enumtypes</code> dictionary maps the names of
+Enum types defined for the <a href="#netCDF4.Group"><code>Group</code></a> or <a href="#netCDF4.Dataset"><code>Dataset</code></a> to instances of the
+<a href="#netCDF4.EnumType"><code>EnumType</code></a> class.</p></div>
<div class="source_cont">
</div>
@@ -3916,9 +3953,14 @@ to a <a href="#netCDF4.Group"><code>Group</code></a> instance (except the <code>
<div class="item">
<p id="netCDF4.Group.file_format" class="name">var <span class="ident">file_format</span></p>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.file_format">file_format</a></code>
+ </p>
+ <div class="desc inherited"><p>same as <code>data_model</code>, retained for backwards compatibility.</p></div>
<div class="source_cont">
</div>
@@ -3926,9 +3968,17 @@ to a <a href="#netCDF4.Group"><code>Group</code></a> instance (except the <code>
<div class="item">
<p id="netCDF4.Group.groups" class="name">var <span class="ident">groups</span></p>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.groups">groups</a></code>
+ </p>
+ <div class="desc inherited"><p>The groups dictionary maps the names of groups created for
+this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or <a href="#netCDF4.Group"><code>Group</code></a> to instances of the <a href="#netCDF4.Group"><code>Group</code></a> class (the
+<a href="#netCDF4.Dataset"><code>Dataset</code></a> class is simply a special case of the <a href="#netCDF4.Group"><code>Group</code></a> class which
+describes the root group in the netCDF4 file).</p></div>
<div class="source_cont">
</div>
@@ -3936,9 +3986,15 @@ to a <a href="#netCDF4.Group"><code>Group</code></a> instance (except the <code>
<div class="item">
<p id="netCDF4.Group.keepweakref" class="name">var <span class="ident">keepweakref</span></p>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.keepweakref">keepweakref</a></code>
+ </p>
+ <div class="desc inherited"><p>If <code>True</code>, child Dimension and Variables objects only keep weak references to
+the parent Dataset or Group.</p></div>
<div class="source_cont">
</div>
@@ -3957,9 +4013,15 @@ to a <a href="#netCDF4.Group"><code>Group</code></a> instance (except the <code>
<div class="item">
<p id="netCDF4.Group.parent" class="name">var <span class="ident">parent</span></p>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.parent">parent</a></code>
+ </p>
+ <div class="desc inherited"><p><code>parent</code> is a reference to the parent
+<a href="#netCDF4.Group"><code>Group</code></a> instance. <code>None</code> for the root group or <a href="#netCDF4.Dataset"><code>Dataset</code></a> instance</p></div>
<div class="source_cont">
</div>
@@ -3967,9 +4029,17 @@ to a <a href="#netCDF4.Group"><code>Group</code></a> instance (except the <code>
<div class="item">
<p id="netCDF4.Group.path" class="name">var <span class="ident">path</span></p>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.path">path</a></code>
+ </p>
+ <div class="desc inherited"><p><code>path</code> shows the location of the <a href="#netCDF4.Group"><code>Group</code></a> in
+the <a href="#netCDF4.Dataset"><code>Dataset</code></a> in a unix directory format (the names of groups in the
+hierarchy separated by backslashes). A <a href="#netCDF4.Dataset"><code>Dataset</code></a> instance is the root
+group, so the path is simply <code>'/'</code>.</p></div>
<div class="source_cont">
</div>
@@ -3977,9 +4047,16 @@ to a <a href="#netCDF4.Group"><code>Group</code></a> instance (except the <code>
<div class="item">
<p id="netCDF4.Group.variables" class="name">var <span class="ident">variables</span></p>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.variables">variables</a></code>
+ </p>
+ <div class="desc inherited"><p>The <code>variables</code> dictionary maps the names of variables
+defined for this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or <a href="#netCDF4.Group"><code>Group</code></a> to instances of the <a href="#netCDF4.Variable"><code>Variable</code></a>
+class.</p></div>
<div class="source_cont">
</div>
@@ -3987,9 +4064,16 @@ to a <a href="#netCDF4.Group"><code>Group</code></a> instance (except the <code>
<div class="item">
<p id="netCDF4.Group.vltypes" class="name">var <span class="ident">vltypes</span></p>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.vltypes">vltypes</a></code>
+ </p>
+ <div class="desc inherited"><p>The <code>vltypes</code> dictionary maps the names of
+variable-length types defined for the <a href="#netCDF4.Group"><code>Group</code></a> or <a href="#netCDF4.Dataset"><code>Dataset</code></a> to instances of the
+<a href="#netCDF4.VLType"><code>VLType</code></a> class.</p></div>
<div class="source_cont">
</div>
@@ -4026,6 +4110,10 @@ another <a href="#netCDF4.Group"><code>Group</code></a> instance, not using this
<p>def <span class="ident">close</span>(</p><p>self)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.close">close</a></code>
+ </p>
@@ -4042,10 +4130,14 @@ instances, raises IOError.</p></div>
<p>def <span class="ident">createCompoundType</span>(</p><p>self, datatype, datatype_name)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.createCompoundType">createCompoundType</a></code>
+ </p>
- <div class="desc"><p>Creates a new compound data type named <code>datatype_name</code> from the numpy
+ <div class="desc inherited"><p>Creates a new compound data type named <code>datatype_name</code> from the numpy
dtype object <code>datatype</code>.</p>
<p><strong><em>Note</em></strong>: If the new compound data type contains other compound data types
(i.e. it is a 'nested' compound type, where not all of the elements
@@ -4064,10 +4156,14 @@ datatype.</p></div>
<p>def <span class="ident">createDimension</span>(</p><p>self, dimname, size=None)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.createDimension">createDimension</a></code>
+ </p>
- <div class="desc"><p>Creates a new dimension with the given <code>dimname</code> and <code>size</code>.</p>
+ <div class="desc inherited"><p>Creates a new dimension with the given <code>dimname</code> and <code>size</code>.</p>
<p><code>size</code> must be a positive integer or <code>None</code>, which stands for
"unlimited" (default is <code>None</code>). Specifying a size of 0 also
results in an unlimited dimension. The return value is the <a href="#netCDF4.Dimension"><code>Dimension</code></a>
@@ -4086,10 +4182,14 @@ instance. To determine if a dimension is 'unlimited', use the
<p>def <span class="ident">createEnumType</span>(</p><p>self, datatype, datatype_name, enum_dict)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.createEnumType">createEnumType</a></code>
+ </p>
- <div class="desc"><p>Creates a new Enum data type named <code>datatype_name</code> from a numpy
+ <div class="desc inherited"><p>Creates a new Enum data type named <code>datatype_name</code> from a numpy
integer dtype object <code>datatype</code>, and a python dictionary
defining the enum fields and values.</p>
<p>The return value is the <a href="#netCDF4.EnumType"><code>EnumType</code></a> class instance describing the new
@@ -4105,10 +4205,14 @@ datatype.</p></div>
<p>def <span class="ident">createGroup</span>(</p><p>self, groupname)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.createGroup">createGroup</a></code>
+ </p>
- <div class="desc"><p>Creates a new <a href="#netCDF4.Group"><code>Group</code></a> with the given <code>groupname</code>.</p>
+ <div class="desc inherited"><p>Creates a new <a href="#netCDF4.Group"><code>Group</code></a> with the given <code>groupname</code>.</p>
<p>If <code>groupname</code> is specified as a path, using forward slashes as in unix to
separate components, then intermediate groups will be created as necessary
(analogous to <code>mkdir -p</code> in unix). For example,
@@ -4128,10 +4232,14 @@ raised.</p>
<p>def <span class="ident">createVLType</span>(</p><p>self, datatype, datatype_name)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.createVLType">createVLType</a></code>
+ </p>
- <div class="desc"><p>Creates a new VLEN data type named <code>datatype_name</code> from a numpy
+ <div class="desc inherited"><p>Creates a new VLEN data type named <code>datatype_name</code> from a numpy
dtype object <code>datatype</code>.</p>
<p>The return value is the <a href="#netCDF4.VLType"><code>VLType</code></a> class instance describing the new
datatype.</p></div>
@@ -4146,10 +4254,14 @@ datatype.</p></div>
<p>def <span class="ident">createVariable</span>(</p><p>self, varname, datatype, dimensions=(), zlib=False, complevel=4, shuffle=True, fletcher32=False, contiguous=False, chunksizes=None, endian='native', least_significant_digit=None, fill_value=None)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.createVariable">createVariable</a></code>
+ </p>
- <div class="desc"><p>Creates a new variable with the given <code>varname</code>, <code>datatype</code>, and
+ <div class="desc inherited"><p>Creates a new variable with the given <code>varname</code>, <code>datatype</code>, and
<code>dimensions</code>. If dimensions are not given, the variable is assumed to be
a scalar.</p>
<p>If <code>varname</code> is specified as a path, using forward slashes as in unix to
@@ -4259,10 +4371,14 @@ is the number of variable dimensions.</p></div>
<p>def <span class="ident">delncattr</span>(</p><p>self,name,value)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.delncattr">delncattr</a></code>
+ </p>
- <div class="desc"><p>delete a netCDF dataset or group attribute. Use if you need to delete a
+ <div class="desc inherited"><p>delete a netCDF dataset or group attribute. Use if you need to delete a
netCDF attribute with the same name as one of the reserved python
attributes.</p></div>
<div class="source_cont">
@@ -4276,10 +4392,14 @@ attributes.</p></div>
<p>def <span class="ident">filepath</span>(</p><p>self,encoding=None)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.filepath">filepath</a></code>
+ </p>
- <div class="desc"><p>Get the file system path (or the opendap URL) which was used to
+ <div class="desc inherited"><p>Get the file system path (or the opendap URL) which was used to
open/create the Dataset. Requires netcdf >= 4.1.2. The path
is decoded into a string using <code>sys.getfilesystemencoding()</code> by default, this can be
changed using the <code>encoding</code> kwarg.</p></div>
@@ -4294,10 +4414,14 @@ changed using the <code>encoding</code> kwarg.</p></div>
<p>def <span class="ident">get_variables_by_attributes</span>(</p><p>...)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.get_variables_by_attributes">get_variables_by_attributes</a></code>
+ </p>
- <div class="desc"><p>Returns a list of variables that match specific conditions.</p>
+ <div class="desc inherited"><p>Returns a list of variables that match specific conditions.</p>
<p>Can pass in key=value parameters and variables are returned that
contain all of the matches. For example,</p>
<div class="codehilite"><pre><span></span><span class="o">>>></span> <span class="c1"># Get variables with x-axis attribute.</span>
@@ -4329,10 +4453,14 @@ attribute does not exist on the variable. For example,</p>
<p>def <span class="ident">getncattr</span>(</p><p>self,name)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.getncattr">getncattr</a></code>
+ </p>
- <div class="desc"><p>retrieve a netCDF dataset or group attribute.
+ <div class="desc inherited"><p>retrieve a netCDF dataset or group attribute.
Use if you need to get a netCDF attribute with the same
name as one of the reserved python attributes.</p>
<p>option kwarg <code>encoding</code> can be used to specify the
@@ -4348,10 +4476,14 @@ character encoding of a string attribute (default is <code>utf-8</code>).</p></d
<p>def <span class="ident">isopen</span>(</p><p>...)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.isopen">isopen</a></code>
+ </p>
- <div class="desc"><p>is the Dataset open or closed?</p></div>
+ <div class="desc inherited"><p>is the Dataset open or closed?</p></div>
<div class="source_cont">
</div>
@@ -4363,10 +4495,14 @@ character encoding of a string attribute (default is <code>utf-8</code>).</p></d
<p>def <span class="ident">ncattrs</span>(</p><p>self)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.ncattrs">ncattrs</a></code>
+ </p>
- <div class="desc"><p>return netCDF global attribute names for this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or <a href="#netCDF4.Group"><code>Group</code></a> in a list.</p></div>
+ <div class="desc inherited"><p>return netCDF global attribute names for this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or <a href="#netCDF4.Group"><code>Group</code></a> in a list.</p></div>
<div class="source_cont">
</div>
@@ -4378,10 +4514,14 @@ character encoding of a string attribute (default is <code>utf-8</code>).</p></d
<p>def <span class="ident">renameAttribute</span>(</p><p>self, oldname, newname)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.renameAttribute">renameAttribute</a></code>
+ </p>
- <div class="desc"><p>rename a <a href="#netCDF4.Dataset"><code>Dataset</code></a> or <a href="#netCDF4.Group"><code>Group</code></a> attribute named <code>oldname</code> to <code>newname</code>.</p></div>
+ <div class="desc inherited"><p>rename a <a href="#netCDF4.Dataset"><code>Dataset</code></a> or <a href="#netCDF4.Group"><code>Group</code></a> attribute named <code>oldname</code> to <code>newname</code>.</p></div>
<div class="source_cont">
</div>
@@ -4393,10 +4533,14 @@ character encoding of a string attribute (default is <code>utf-8</code>).</p></d
<p>def <span class="ident">renameDimension</span>(</p><p>self, oldname, newname)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.renameDimension">renameDimension</a></code>
+ </p>
- <div class="desc"><p>rename a <a href="#netCDF4.Dimension"><code>Dimension</code></a> named <code>oldname</code> to <code>newname</code>.</p></div>
+ <div class="desc inherited"><p>rename a <a href="#netCDF4.Dimension"><code>Dimension</code></a> named <code>oldname</code> to <code>newname</code>.</p></div>
<div class="source_cont">
</div>
@@ -4408,10 +4552,14 @@ character encoding of a string attribute (default is <code>utf-8</code>).</p></d
<p>def <span class="ident">renameGroup</span>(</p><p>self, oldname, newname)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.renameGroup">renameGroup</a></code>
+ </p>
- <div class="desc"><p>rename a <a href="#netCDF4.Group"><code>Group</code></a> named <code>oldname</code> to <code>newname</code> (requires netcdf >= 4.3.1).</p></div>
+ <div class="desc inherited"><p>rename a <a href="#netCDF4.Group"><code>Group</code></a> named <code>oldname</code> to <code>newname</code> (requires netcdf >= 4.3.1).</p></div>
<div class="source_cont">
</div>
@@ -4423,10 +4571,14 @@ character encoding of a string attribute (default is <code>utf-8</code>).</p></d
<p>def <span class="ident">renameVariable</span>(</p><p>self, oldname, newname)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.renameVariable">renameVariable</a></code>
+ </p>
- <div class="desc"><p>rename a <a href="#netCDF4.Variable"><code>Variable</code></a> named <code>oldname</code> to <code>newname</code></p></div>
+ <div class="desc inherited"><p>rename a <a href="#netCDF4.Variable"><code>Variable</code></a> named <code>oldname</code> to <code>newname</code></p></div>
<div class="source_cont">
</div>
@@ -4438,10 +4590,14 @@ character encoding of a string attribute (default is <code>utf-8</code>).</p></d
<p>def <span class="ident">set_always_mask</span>(</p><p>self, True_or_False)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.set_always_mask">set_always_mask</a></code>
+ </p>
- <div class="desc"><p>Call <a href="#netCDF4.Variable.set_always_mask"><code>set_always_mask</code></a> for all variables contained in
+ <div class="desc inherited"><p>Call <a href="#netCDF4.Variable.set_always_mask"><code>set_always_mask</code></a> for all variables contained in
this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or <a href="#netCDF4.Group"><code>Group</code></a>, as well as for all
variables in all its subgroups.</p>
<p><strong><code>True_or_False</code></strong>: Boolean determining if automatic conversion of
@@ -4461,10 +4617,14 @@ the default behaviour.</p></div>
<p>def <span class="ident">set_auto_chartostring</span>(</p><p>self, True_or_False)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.set_auto_chartostring">set_auto_chartostring</a></code>
+ </p>
- <div class="desc"><p>Call <a href="#netCDF4.Variable.set_auto_chartostring"><code>set_auto_chartostring</code></a> for all variables contained in this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or
+ <div class="desc inherited"><p>Call <a href="#netCDF4.Variable.set_auto_chartostring"><code>set_auto_chartostring</code></a> for all variables contained in this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or
<a href="#netCDF4.Group"><code>Group</code></a>, as well as for all variables in all its subgroups.</p>
<p><strong><code>True_or_False</code></strong>: Boolean determining if automatic conversion of
all character arrays <--> string arrays should be performed for
@@ -4483,10 +4643,14 @@ after calling this function will follow the default behaviour.</p></div>
<p>def <span class="ident">set_auto_mask</span>(</p><p>self, True_or_False)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.set_auto_mask">set_auto_mask</a></code>
+ </p>
- <div class="desc"><p>Call <a href="#netCDF4.Variable.set_auto_mask"><code>set_auto_mask</code></a> for all variables contained in this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or
+ <div class="desc inherited"><p>Call <a href="#netCDF4.Variable.set_auto_mask"><code>set_auto_mask</code></a> for all variables contained in this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or
<a href="#netCDF4.Group"><code>Group</code></a>, as well as for all variables in all its subgroups.</p>
<p><strong><code>True_or_False</code></strong>: Boolean determining if automatic conversion to masked arrays
shall be applied for all variables.</p>
@@ -4503,10 +4667,14 @@ after calling this function will follow the default behaviour.</p></div>
<p>def <span class="ident">set_auto_maskandscale</span>(</p><p>self, True_or_False)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.set_auto_maskandscale">set_auto_maskandscale</a></code>
+ </p>
- <div class="desc"><p>Call <a href="#netCDF4.Variable.set_auto_maskandscale"><code>set_auto_maskandscale</code></a> for all variables contained in this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or
+ <div class="desc inherited"><p>Call <a href="#netCDF4.Variable.set_auto_maskandscale"><code>set_auto_maskandscale</code></a> for all variables contained in this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or
<a href="#netCDF4.Group"><code>Group</code></a>, as well as for all variables in all its subgroups.</p>
<p><strong><code>True_or_False</code></strong>: Boolean determining if automatic conversion to masked arrays
and variable scaling shall be applied for all variables.</p>
@@ -4523,10 +4691,14 @@ after calling this function will follow the default behaviour.</p></div>
<p>def <span class="ident">set_auto_scale</span>(</p><p>self, True_or_False)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.set_auto_scale">set_auto_scale</a></code>
+ </p>
- <div class="desc"><p>Call <a href="#netCDF4.Variable.set_auto_scale"><code>set_auto_scale</code></a> for all variables contained in this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or
+ <div class="desc inherited"><p>Call <a href="#netCDF4.Variable.set_auto_scale"><code>set_auto_scale</code></a> for all variables contained in this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or
<a href="#netCDF4.Group"><code>Group</code></a>, as well as for all variables in all its subgroups.</p>
<p><strong><code>True_or_False</code></strong>: Boolean determining if automatic variable scaling
shall be applied for all variables.</p>
@@ -4543,10 +4715,14 @@ after calling this function will follow the default behaviour.</p></div>
<p>def <span class="ident">set_fill_off</span>(</p><p>self)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.set_fill_off">set_fill_off</a></code>
+ </p>
- <div class="desc"><p>Sets the fill mode for a <a href="#netCDF4.Dataset"><code>Dataset</code></a> open for writing to <code>off</code>.</p>
+ <div class="desc inherited"><p>Sets the fill mode for a <a href="#netCDF4.Dataset"><code>Dataset</code></a> open for writing to <code>off</code>.</p>
<p>This will prevent the data from being pre-filled with fill values, which
may result in some performance improvements. However, you must then make
sure the data is actually written before being read.</p></div>
@@ -4561,10 +4737,14 @@ sure the data is actually written before being read.</p></div>
<p>def <span class="ident">set_fill_on</span>(</p><p>self)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.set_fill_on">set_fill_on</a></code>
+ </p>
- <div class="desc"><p>Sets the fill mode for a <a href="#netCDF4.Dataset"><code>Dataset</code></a> open for writing to <code>on</code>.</p>
+ <div class="desc inherited"><p>Sets the fill mode for a <a href="#netCDF4.Dataset"><code>Dataset</code></a> open for writing to <code>on</code>.</p>
<p>This causes data to be pre-filled with fill values. The fill values can be
controlled by the variable's <code>_Fill_Value</code> attribute, but is usually
sufficient to the use the netCDF default <code>_Fill_Value</code> (defined
@@ -4583,10 +4763,14 @@ to.</p></div>
<p>def <span class="ident">set_ncstring_attrs</span>(</p><p>self, True_or_False)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.set_ncstring_attrs">set_ncstring_attrs</a></code>
+ </p>
- <div class="desc"><p>Call <a href="#netCDF4.Variable.set_ncstring_attrs"><code>set_ncstring_attrs</code></a> for all variables contained in
+ <div class="desc inherited"><p>Call <a href="#netCDF4.Variable.set_ncstring_attrs"><code>set_ncstring_attrs</code></a> for all variables contained in
this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or <a href="#netCDF4.Group"><code>Group</code></a>, as well as for all its
subgroups and their variables.</p>
<p><strong><code>True_or_False</code></strong>: Boolean determining if all string attributes are
@@ -4605,10 +4789,14 @@ of existing (sub-) groups and their variables.</p></div>
<p>def <span class="ident">setncattr</span>(</p><p>self,name,value)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.setncattr">setncattr</a></code>
+ </p>
- <div class="desc"><p>set a netCDF dataset or group attribute using name,value pair.
+ <div class="desc inherited"><p>set a netCDF dataset or group attribute using name,value pair.
Use if you need to set a netCDF attribute with the
with the same name as one of the reserved python attributes.</p></div>
<div class="source_cont">
@@ -4622,10 +4810,14 @@ with the same name as one of the reserved python attributes.</p></div>
<p>def <span class="ident">setncattr_string</span>(</p><p>self,name,value)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.setncattr_string">setncattr_string</a></code>
+ </p>
- <div class="desc"><p>set a netCDF dataset or group string attribute using name,value pair.
+ <div class="desc inherited"><p>set a netCDF dataset or group string attribute using name,value pair.
Use if you need to ensure that a netCDF attribute is created with type
<code>NC_STRING</code> if the file format is <code>NETCDF4</code>.</p></div>
<div class="source_cont">
@@ -4639,10 +4831,14 @@ Use if you need to ensure that a netCDF attribute is created with type
<p>def <span class="ident">setncatts</span>(</p><p>self,attdict)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.setncatts">setncatts</a></code>
+ </p>
- <div class="desc"><p>set a bunch of netCDF dataset or group attributes at once using a python dictionary.
+ <div class="desc inherited"><p>set a bunch of netCDF dataset or group attributes at once using a python dictionary.
This may be faster when setting a lot of attributes for a <code>NETCDF3</code>
formatted file, since nc_redef/nc_enddef is not called in between setting
each attribute</p></div>
@@ -4657,10 +4853,14 @@ each attribute</p></div>
<p>def <span class="ident">sync</span>(</p><p>self)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.sync">sync</a></code>
+ </p>
- <div class="desc"><p>Writes all buffered data in the <a href="#netCDF4.Dataset"><code>Dataset</code></a> to the disk file.</p></div>
+ <div class="desc inherited"><p>Writes all buffered data in the <a href="#netCDF4.Dataset"><code>Dataset</code></a> to the disk file.</p></div>
<div class="source_cont">
</div>
@@ -4705,15 +4905,22 @@ or NETCDF3_64BIT_DATA</code> format (<code>NETCDF4</code> Datasets won't work).<
<ul class="class_list">
<li><a href="#netCDF4.MFDataset">MFDataset</a></li>
<li><a href="#netCDF4.Dataset">Dataset</a></li>
- <li>builtins.object</li>
+ <li>__builtin__.object</li>
</ul>
<h3>Class variables</h3>
<div class="item">
<p id="netCDF4.MFDataset.cmptypes" class="name">var <span class="ident">cmptypes</span></p>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.cmptypes">cmptypes</a></code>
+ </p>
+ <div class="desc inherited"><p>The <code>cmptypes</code> dictionary maps the names of
+compound types defined for the <a href="#netCDF4.Group"><code>Group</code></a> or <a href="#netCDF4.Dataset"><code>Dataset</code></a> to instances of the
+<a href="#netCDF4.CompoundType"><code>CompoundType</code></a> class.</p></div>
<div class="source_cont">
</div>
@@ -4721,9 +4928,16 @@ or NETCDF3_64BIT_DATA</code> format (<code>NETCDF4</code> Datasets won't work).<
<div class="item">
<p id="netCDF4.MFDataset.data_model" class="name">var <span class="ident">data_model</span></p>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.data_model">data_model</a></code>
+ </p>
+ <div class="desc inherited"><p><code>data_model</code> describes the netCDF
+data model version, one of <code>NETCDF3_CLASSIC</code>, <code>NETCDF4</code>,
+<code>NETCDF4_CLASSIC</code>, <code>NETCDF3_64BIT_OFFSET</code> or <code>NETCDF3_64BIT_DATA</code>.</p></div>
<div class="source_cont">
</div>
@@ -4731,9 +4945,16 @@ or NETCDF3_64BIT_DATA</code> format (<code>NETCDF4</code> Datasets won't work).<
<div class="item">
<p id="netCDF4.MFDataset.dimensions" class="name">var <span class="ident">dimensions</span></p>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.dimensions">dimensions</a></code>
+ </p>
+ <div class="desc inherited"><p>The <code>dimensions</code> dictionary maps the names of
+dimensions defined for the <a href="#netCDF4.Group"><code>Group</code></a> or <a href="#netCDF4.Dataset"><code>Dataset</code></a> to instances of the
+<a href="#netCDF4.Dimension"><code>Dimension</code></a> class.</p></div>
<div class="source_cont">
</div>
@@ -4741,9 +4962,18 @@ or NETCDF3_64BIT_DATA</code> format (<code>NETCDF4</code> Datasets won't work).<
<div class="item">
<p id="netCDF4.MFDataset.disk_format" class="name">var <span class="ident">disk_format</span></p>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.disk_format">disk_format</a></code>
+ </p>
+ <div class="desc inherited"><p><code>disk_format</code> describes the underlying
+file format, one of <code>NETCDF3</code>, <code>HDF5</code>, <code>HDF4</code>,
+<code>PNETCDF</code>, <code>DAP2</code>, <code>DAP4</code> or <code>UNDEFINED</code>. Only available if using
+netcdf C library version >= 4.3.1, otherwise will always return
+<code>UNDEFINED</code>.</p></div>
<div class="source_cont">
</div>
@@ -4751,9 +4981,16 @@ or NETCDF3_64BIT_DATA</code> format (<code>NETCDF4</code> Datasets won't work).<
<div class="item">
<p id="netCDF4.MFDataset.enumtypes" class="name">var <span class="ident">enumtypes</span></p>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.enumtypes">enumtypes</a></code>
+ </p>
+ <div class="desc inherited"><p>The <code>enumtypes</code> dictionary maps the names of
+Enum types defined for the <a href="#netCDF4.Group"><code>Group</code></a> or <a href="#netCDF4.Dataset"><code>Dataset</code></a> to instances of the
+<a href="#netCDF4.EnumType"><code>EnumType</code></a> class.</p></div>
<div class="source_cont">
</div>
@@ -4761,9 +4998,14 @@ or NETCDF3_64BIT_DATA</code> format (<code>NETCDF4</code> Datasets won't work).<
<div class="item">
<p id="netCDF4.MFDataset.file_format" class="name">var <span class="ident">file_format</span></p>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.file_format">file_format</a></code>
+ </p>
+ <div class="desc inherited"><p>same as <code>data_model</code>, retained for backwards compatibility.</p></div>
<div class="source_cont">
</div>
@@ -4771,9 +5013,17 @@ or NETCDF3_64BIT_DATA</code> format (<code>NETCDF4</code> Datasets won't work).<
<div class="item">
<p id="netCDF4.MFDataset.groups" class="name">var <span class="ident">groups</span></p>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.groups">groups</a></code>
+ </p>
+ <div class="desc inherited"><p>The groups dictionary maps the names of groups created for
+this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or <a href="#netCDF4.Group"><code>Group</code></a> to instances of the <a href="#netCDF4.Group"><code>Group</code></a> class (the
+<a href="#netCDF4.Dataset"><code>Dataset</code></a> class is simply a special case of the <a href="#netCDF4.Group"><code>Group</code></a> class which
+describes the root group in the netCDF4 file).</p></div>
<div class="source_cont">
</div>
@@ -4781,9 +5031,15 @@ or NETCDF3_64BIT_DATA</code> format (<code>NETCDF4</code> Datasets won't work).<
<div class="item">
<p id="netCDF4.MFDataset.keepweakref" class="name">var <span class="ident">keepweakref</span></p>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.keepweakref">keepweakref</a></code>
+ </p>
+ <div class="desc inherited"><p>If <code>True</code>, child Dimension and Variables objects only keep weak references to
+the parent Dataset or Group.</p></div>
<div class="source_cont">
</div>
@@ -4791,9 +5047,15 @@ or NETCDF3_64BIT_DATA</code> format (<code>NETCDF4</code> Datasets won't work).<
<div class="item">
<p id="netCDF4.MFDataset.parent" class="name">var <span class="ident">parent</span></p>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.parent">parent</a></code>
+ </p>
+ <div class="desc inherited"><p><code>parent</code> is a reference to the parent
+<a href="#netCDF4.Group"><code>Group</code></a> instance. <code>None</code> for the root group or <a href="#netCDF4.Dataset"><code>Dataset</code></a> instance</p></div>
<div class="source_cont">
</div>
@@ -4801,9 +5063,17 @@ or NETCDF3_64BIT_DATA</code> format (<code>NETCDF4</code> Datasets won't work).<
<div class="item">
<p id="netCDF4.MFDataset.path" class="name">var <span class="ident">path</span></p>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.path">path</a></code>
+ </p>
+ <div class="desc inherited"><p><code>path</code> shows the location of the <a href="#netCDF4.Group"><code>Group</code></a> in
+the <a href="#netCDF4.Dataset"><code>Dataset</code></a> in a unix directory format (the names of groups in the
+hierarchy separated by backslashes). A <a href="#netCDF4.Dataset"><code>Dataset</code></a> instance is the root
+group, so the path is simply <code>'/'</code>.</p></div>
<div class="source_cont">
</div>
@@ -4811,9 +5081,16 @@ or NETCDF3_64BIT_DATA</code> format (<code>NETCDF4</code> Datasets won't work).<
<div class="item">
<p id="netCDF4.MFDataset.variables" class="name">var <span class="ident">variables</span></p>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.variables">variables</a></code>
+ </p>
+ <div class="desc inherited"><p>The <code>variables</code> dictionary maps the names of variables
+defined for this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or <a href="#netCDF4.Group"><code>Group</code></a> to instances of the <a href="#netCDF4.Variable"><code>Variable</code></a>
+class.</p></div>
<div class="source_cont">
</div>
@@ -4821,84 +5098,35 @@ or NETCDF3_64BIT_DATA</code> format (<code>NETCDF4</code> Datasets won't work).<
<div class="item">
<p id="netCDF4.MFDataset.vltypes" class="name">var <span class="ident">vltypes</span></p>
-
-
-
- <div class="source_cont">
-</div>
-
- </div>
- <h3>Static methods</h3>
-
- <div class="item">
- <div class="name def" id="netCDF4.MFDataset.__init__">
- <p>def <span class="ident">__init__</span>(</p><p>self, files, check=False, aggdim=None, exclude=[], master_file=None)</p>
- </div>
-
<p class="inheritance">
<strong>Inheritance:</strong>
- <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.__init__">__init__</a></code>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.vltypes">vltypes</a></code>
</p>
-
-
- <div class="desc"><p><strong><code>__init__(self, files, check=False, aggdim=None, exclude=[],
-master_file=None)</code></strong></p>
-<p>Open a Dataset spanning multiple files, making it look as if it was a
-single file. Variables in the list of files that share the same
-dimension (specified with the keyword <code>aggdim</code>) are aggregated. If
-<code>aggdim</code> is not specified, the unlimited is aggregated. Currently,
-<code>aggdim</code> must be the leftmost (slowest varying) dimension of each
-of the variables to be aggregated.</p>
-<p><strong><code>files</code></strong>: either a sequence of netCDF files or a string with a
-wildcard (converted to a sorted list of files using glob) If
-the <code>master_file</code> kwarg is not specified, the first file
-in the list will become the "master" file, defining all the
-variables with an aggregation dimension which may span
-subsequent files. Attribute access returns attributes only from "master"
-file. The files are always opened in read-only mode.</p>
-<p><strong><code>check</code></strong>: True if you want to do consistency checking to ensure the
-correct variables structure for all of the netcdf files. Checking makes
-the initialization of the MFDataset instance much slower. Default is
-False.</p>
-<p><strong><code>aggdim</code></strong>: The name of the dimension to aggregate over (must
-be the leftmost dimension of each of the variables to be aggregated).
-If None (default), aggregate over the unlimited dimension.</p>
-<p><strong><code>exclude</code></strong>: A list of variable names to exclude from aggregation.
-Default is an empty list.</p>
-<p><strong><code>master_file</code></strong>: file to use as "master file", defining all the
-variables with an aggregation dimension and all global attributes.</p></div>
- <div class="source_cont">
-</div>
-
- </div>
-
- <div class="item">
- <div class="name def" id="netCDF4.MFDataset.close">
- <p>def <span class="ident">close</span>(</p><p>self)</p>
- </div>
-
-
-
- <div class="desc"><p><strong><code>close(self)</code></strong></p>
-<p>close all the open files.</p></div>
+ <div class="desc inherited"><p>The <code>vltypes</code> dictionary maps the names of
+variable-length types defined for the <a href="#netCDF4.Group"><code>Group</code></a> or <a href="#netCDF4.Dataset"><code>Dataset</code></a> to instances of the
+<a href="#netCDF4.VLType"><code>VLType</code></a> class.</p></div>
<div class="source_cont">
</div>
- </div>
-
+ </div>
+ <h3>Static methods</h3>
<div class="item">
<div class="name def" id="netCDF4.MFDataset.createCompoundType">
<p>def <span class="ident">createCompoundType</span>(</p><p>self, datatype, datatype_name)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.createCompoundType">createCompoundType</a></code>
+ </p>
- <div class="desc"><p>Creates a new compound data type named <code>datatype_name</code> from the numpy
+ <div class="desc inherited"><p>Creates a new compound data type named <code>datatype_name</code> from the numpy
dtype object <code>datatype</code>.</p>
<p><strong><em>Note</em></strong>: If the new compound data type contains other compound data types
(i.e. it is a 'nested' compound type, where not all of the elements
@@ -4917,10 +5145,14 @@ datatype.</p></div>
<p>def <span class="ident">createDimension</span>(</p><p>self, dimname, size=None)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.createDimension">createDimension</a></code>
+ </p>
- <div class="desc"><p>Creates a new dimension with the given <code>dimname</code> and <code>size</code>.</p>
+ <div class="desc inherited"><p>Creates a new dimension with the given <code>dimname</code> and <code>size</code>.</p>
<p><code>size</code> must be a positive integer or <code>None</code>, which stands for
"unlimited" (default is <code>None</code>). Specifying a size of 0 also
results in an unlimited dimension. The return value is the <a href="#netCDF4.Dimension"><code>Dimension</code></a>
@@ -4939,10 +5171,14 @@ instance. To determine if a dimension is 'unlimited', use the
<p>def <span class="ident">createEnumType</span>(</p><p>self, datatype, datatype_name, enum_dict)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.createEnumType">createEnumType</a></code>
+ </p>
- <div class="desc"><p>Creates a new Enum data type named <code>datatype_name</code> from a numpy
+ <div class="desc inherited"><p>Creates a new Enum data type named <code>datatype_name</code> from a numpy
integer dtype object <code>datatype</code>, and a python dictionary
defining the enum fields and values.</p>
<p>The return value is the <a href="#netCDF4.EnumType"><code>EnumType</code></a> class instance describing the new
@@ -4958,10 +5194,14 @@ datatype.</p></div>
<p>def <span class="ident">createGroup</span>(</p><p>self, groupname)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.createGroup">createGroup</a></code>
+ </p>
- <div class="desc"><p>Creates a new <a href="#netCDF4.Group"><code>Group</code></a> with the given <code>groupname</code>.</p>
+ <div class="desc inherited"><p>Creates a new <a href="#netCDF4.Group"><code>Group</code></a> with the given <code>groupname</code>.</p>
<p>If <code>groupname</code> is specified as a path, using forward slashes as in unix to
separate components, then intermediate groups will be created as necessary
(analogous to <code>mkdir -p</code> in unix). For example,
@@ -4981,10 +5221,14 @@ raised.</p>
<p>def <span class="ident">createVLType</span>(</p><p>self, datatype, datatype_name)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.createVLType">createVLType</a></code>
+ </p>
- <div class="desc"><p>Creates a new VLEN data type named <code>datatype_name</code> from a numpy
+ <div class="desc inherited"><p>Creates a new VLEN data type named <code>datatype_name</code> from a numpy
dtype object <code>datatype</code>.</p>
<p>The return value is the <a href="#netCDF4.VLType"><code>VLType</code></a> class instance describing the new
datatype.</p></div>
@@ -4999,10 +5243,14 @@ datatype.</p></div>
<p>def <span class="ident">createVariable</span>(</p><p>self, varname, datatype, dimensions=(), zlib=False, complevel=4, shuffle=True, fletcher32=False, contiguous=False, chunksizes=None, endian='native', least_significant_digit=None, fill_value=None)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.createVariable">createVariable</a></code>
+ </p>
- <div class="desc"><p>Creates a new variable with the given <code>varname</code>, <code>datatype</code>, and
+ <div class="desc inherited"><p>Creates a new variable with the given <code>varname</code>, <code>datatype</code>, and
<code>dimensions</code>. If dimensions are not given, the variable is assumed to be
a scalar.</p>
<p>If <code>varname</code> is specified as a path, using forward slashes as in unix to
@@ -5112,10 +5360,14 @@ is the number of variable dimensions.</p></div>
<p>def <span class="ident">delncattr</span>(</p><p>self,name,value)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.delncattr">delncattr</a></code>
+ </p>
- <div class="desc"><p>delete a netCDF dataset or group attribute. Use if you need to delete a
+ <div class="desc inherited"><p>delete a netCDF dataset or group attribute. Use if you need to delete a
netCDF attribute with the same name as one of the reserved python
attributes.</p></div>
<div class="source_cont">
@@ -5129,10 +5381,14 @@ attributes.</p></div>
<p>def <span class="ident">filepath</span>(</p><p>self,encoding=None)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.filepath">filepath</a></code>
+ </p>
- <div class="desc"><p>Get the file system path (or the opendap URL) which was used to
+ <div class="desc inherited"><p>Get the file system path (or the opendap URL) which was used to
open/create the Dataset. Requires netcdf >= 4.1.2. The path
is decoded into a string using <code>sys.getfilesystemencoding()</code> by default, this can be
changed using the <code>encoding</code> kwarg.</p></div>
@@ -5147,10 +5403,14 @@ changed using the <code>encoding</code> kwarg.</p></div>
<p>def <span class="ident">get_variables_by_attributes</span>(</p><p>...)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.get_variables_by_attributes">get_variables_by_attributes</a></code>
+ </p>
- <div class="desc"><p>Returns a list of variables that match specific conditions.</p>
+ <div class="desc inherited"><p>Returns a list of variables that match specific conditions.</p>
<p>Can pass in key=value parameters and variables are returned that
contain all of the matches. For example,</p>
<div class="codehilite"><pre><span></span><span class="o">>>></span> <span class="c1"># Get variables with x-axis attribute.</span>
@@ -5182,10 +5442,14 @@ attribute does not exist on the variable. For example,</p>
<p>def <span class="ident">getncattr</span>(</p><p>self,name)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.getncattr">getncattr</a></code>
+ </p>
- <div class="desc"><p>retrieve a netCDF dataset or group attribute.
+ <div class="desc inherited"><p>retrieve a netCDF dataset or group attribute.
Use if you need to get a netCDF attribute with the same
name as one of the reserved python attributes.</p>
<p>option kwarg <code>encoding</code> can be used to specify the
@@ -5201,26 +5465,14 @@ character encoding of a string attribute (default is <code>utf-8</code>).</p></d
<p>def <span class="ident">isopen</span>(</p><p>...)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.isopen">isopen</a></code>
+ </p>
- <div class="desc"><p>is the Dataset open or closed?</p></div>
- <div class="source_cont">
-</div>
-
- </div>
-
-
- <div class="item">
- <div class="name def" id="netCDF4.MFDataset.ncattrs">
- <p>def <span class="ident">ncattrs</span>(</p><p>self)</p>
- </div>
-
-
-
-
- <div class="desc"><p><strong><code>ncattrs(self)</code></strong></p>
-<p>return the netcdf attribute names from the master file.</p></div>
+ <div class="desc inherited"><p>is the Dataset open or closed?</p></div>
<div class="source_cont">
</div>
@@ -5232,10 +5484,14 @@ character encoding of a string attribute (default is <code>utf-8</code>).</p></d
<p>def <span class="ident">renameAttribute</span>(</p><p>self, oldname, newname)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.renameAttribute">renameAttribute</a></code>
+ </p>
- <div class="desc"><p>rename a <a href="#netCDF4.Dataset"><code>Dataset</code></a> or <a href="#netCDF4.Group"><code>Group</code></a> attribute named <code>oldname</code> to <code>newname</code>.</p></div>
+ <div class="desc inherited"><p>rename a <a href="#netCDF4.Dataset"><code>Dataset</code></a> or <a href="#netCDF4.Group"><code>Group</code></a> attribute named <code>oldname</code> to <code>newname</code>.</p></div>
<div class="source_cont">
</div>
@@ -5247,10 +5503,14 @@ character encoding of a string attribute (default is <code>utf-8</code>).</p></d
<p>def <span class="ident">renameDimension</span>(</p><p>self, oldname, newname)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.renameDimension">renameDimension</a></code>
+ </p>
- <div class="desc"><p>rename a <a href="#netCDF4.Dimension"><code>Dimension</code></a> named <code>oldname</code> to <code>newname</code>.</p></div>
+ <div class="desc inherited"><p>rename a <a href="#netCDF4.Dimension"><code>Dimension</code></a> named <code>oldname</code> to <code>newname</code>.</p></div>
<div class="source_cont">
</div>
@@ -5262,10 +5522,14 @@ character encoding of a string attribute (default is <code>utf-8</code>).</p></d
<p>def <span class="ident">renameGroup</span>(</p><p>self, oldname, newname)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.renameGroup">renameGroup</a></code>
+ </p>
- <div class="desc"><p>rename a <a href="#netCDF4.Group"><code>Group</code></a> named <code>oldname</code> to <code>newname</code> (requires netcdf >= 4.3.1).</p></div>
+ <div class="desc inherited"><p>rename a <a href="#netCDF4.Group"><code>Group</code></a> named <code>oldname</code> to <code>newname</code> (requires netcdf >= 4.3.1).</p></div>
<div class="source_cont">
</div>
@@ -5277,10 +5541,14 @@ character encoding of a string attribute (default is <code>utf-8</code>).</p></d
<p>def <span class="ident">renameVariable</span>(</p><p>self, oldname, newname)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.renameVariable">renameVariable</a></code>
+ </p>
- <div class="desc"><p>rename a <a href="#netCDF4.Variable"><code>Variable</code></a> named <code>oldname</code> to <code>newname</code></p></div>
+ <div class="desc inherited"><p>rename a <a href="#netCDF4.Variable"><code>Variable</code></a> named <code>oldname</code> to <code>newname</code></p></div>
<div class="source_cont">
</div>
@@ -5292,10 +5560,14 @@ character encoding of a string attribute (default is <code>utf-8</code>).</p></d
<p>def <span class="ident">set_always_mask</span>(</p><p>self, True_or_False)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.set_always_mask">set_always_mask</a></code>
+ </p>
- <div class="desc"><p>Call <a href="#netCDF4.Variable.set_always_mask"><code>set_always_mask</code></a> for all variables contained in
+ <div class="desc inherited"><p>Call <a href="#netCDF4.Variable.set_always_mask"><code>set_always_mask</code></a> for all variables contained in
this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or <a href="#netCDF4.Group"><code>Group</code></a>, as well as for all
variables in all its subgroups.</p>
<p><strong><code>True_or_False</code></strong>: Boolean determining if automatic conversion of
@@ -5315,10 +5587,14 @@ the default behaviour.</p></div>
<p>def <span class="ident">set_auto_chartostring</span>(</p><p>self, True_or_False)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.set_auto_chartostring">set_auto_chartostring</a></code>
+ </p>
- <div class="desc"><p>Call <a href="#netCDF4.Variable.set_auto_chartostring"><code>set_auto_chartostring</code></a> for all variables contained in this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or
+ <div class="desc inherited"><p>Call <a href="#netCDF4.Variable.set_auto_chartostring"><code>set_auto_chartostring</code></a> for all variables contained in this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or
<a href="#netCDF4.Group"><code>Group</code></a>, as well as for all variables in all its subgroups.</p>
<p><strong><code>True_or_False</code></strong>: Boolean determining if automatic conversion of
all character arrays <--> string arrays should be performed for
@@ -5337,10 +5613,14 @@ after calling this function will follow the default behaviour.</p></div>
<p>def <span class="ident">set_auto_mask</span>(</p><p>self, True_or_False)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.set_auto_mask">set_auto_mask</a></code>
+ </p>
- <div class="desc"><p>Call <a href="#netCDF4.Variable.set_auto_mask"><code>set_auto_mask</code></a> for all variables contained in this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or
+ <div class="desc inherited"><p>Call <a href="#netCDF4.Variable.set_auto_mask"><code>set_auto_mask</code></a> for all variables contained in this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or
<a href="#netCDF4.Group"><code>Group</code></a>, as well as for all variables in all its subgroups.</p>
<p><strong><code>True_or_False</code></strong>: Boolean determining if automatic conversion to masked arrays
shall be applied for all variables.</p>
@@ -5357,10 +5637,14 @@ after calling this function will follow the default behaviour.</p></div>
<p>def <span class="ident">set_auto_maskandscale</span>(</p><p>self, True_or_False)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.set_auto_maskandscale">set_auto_maskandscale</a></code>
+ </p>
- <div class="desc"><p>Call <a href="#netCDF4.Variable.set_auto_maskandscale"><code>set_auto_maskandscale</code></a> for all variables contained in this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or
+ <div class="desc inherited"><p>Call <a href="#netCDF4.Variable.set_auto_maskandscale"><code>set_auto_maskandscale</code></a> for all variables contained in this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or
<a href="#netCDF4.Group"><code>Group</code></a>, as well as for all variables in all its subgroups.</p>
<p><strong><code>True_or_False</code></strong>: Boolean determining if automatic conversion to masked arrays
and variable scaling shall be applied for all variables.</p>
@@ -5377,10 +5661,14 @@ after calling this function will follow the default behaviour.</p></div>
<p>def <span class="ident">set_auto_scale</span>(</p><p>self, True_or_False)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.set_auto_scale">set_auto_scale</a></code>
+ </p>
- <div class="desc"><p>Call <a href="#netCDF4.Variable.set_auto_scale"><code>set_auto_scale</code></a> for all variables contained in this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or
+ <div class="desc inherited"><p>Call <a href="#netCDF4.Variable.set_auto_scale"><code>set_auto_scale</code></a> for all variables contained in this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or
<a href="#netCDF4.Group"><code>Group</code></a>, as well as for all variables in all its subgroups.</p>
<p><strong><code>True_or_False</code></strong>: Boolean determining if automatic variable scaling
shall be applied for all variables.</p>
@@ -5397,10 +5685,14 @@ after calling this function will follow the default behaviour.</p></div>
<p>def <span class="ident">set_fill_off</span>(</p><p>self)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.set_fill_off">set_fill_off</a></code>
+ </p>
- <div class="desc"><p>Sets the fill mode for a <a href="#netCDF4.Dataset"><code>Dataset</code></a> open for writing to <code>off</code>.</p>
+ <div class="desc inherited"><p>Sets the fill mode for a <a href="#netCDF4.Dataset"><code>Dataset</code></a> open for writing to <code>off</code>.</p>
<p>This will prevent the data from being pre-filled with fill values, which
may result in some performance improvements. However, you must then make
sure the data is actually written before being read.</p></div>
@@ -5415,10 +5707,14 @@ sure the data is actually written before being read.</p></div>
<p>def <span class="ident">set_fill_on</span>(</p><p>self)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.set_fill_on">set_fill_on</a></code>
+ </p>
- <div class="desc"><p>Sets the fill mode for a <a href="#netCDF4.Dataset"><code>Dataset</code></a> open for writing to <code>on</code>.</p>
+ <div class="desc inherited"><p>Sets the fill mode for a <a href="#netCDF4.Dataset"><code>Dataset</code></a> open for writing to <code>on</code>.</p>
<p>This causes data to be pre-filled with fill values. The fill values can be
controlled by the variable's <code>_Fill_Value</code> attribute, but is usually
sufficient to the use the netCDF default <code>_Fill_Value</code> (defined
@@ -5437,10 +5733,14 @@ to.</p></div>
<p>def <span class="ident">set_ncstring_attrs</span>(</p><p>self, True_or_False)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.set_ncstring_attrs">set_ncstring_attrs</a></code>
+ </p>
- <div class="desc"><p>Call <a href="#netCDF4.Variable.set_ncstring_attrs"><code>set_ncstring_attrs</code></a> for all variables contained in
+ <div class="desc inherited"><p>Call <a href="#netCDF4.Variable.set_ncstring_attrs"><code>set_ncstring_attrs</code></a> for all variables contained in
this <a href="#netCDF4.Dataset"><code>Dataset</code></a> or <a href="#netCDF4.Group"><code>Group</code></a>, as well as for all its
subgroups and their variables.</p>
<p><strong><code>True_or_False</code></strong>: Boolean determining if all string attributes are
@@ -5459,10 +5759,14 @@ of existing (sub-) groups and their variables.</p></div>
<p>def <span class="ident">setncattr</span>(</p><p>self,name,value)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.setncattr">setncattr</a></code>
+ </p>
- <div class="desc"><p>set a netCDF dataset or group attribute using name,value pair.
+ <div class="desc inherited"><p>set a netCDF dataset or group attribute using name,value pair.
Use if you need to set a netCDF attribute with the
with the same name as one of the reserved python attributes.</p></div>
<div class="source_cont">
@@ -5476,10 +5780,14 @@ with the same name as one of the reserved python attributes.</p></div>
<p>def <span class="ident">setncattr_string</span>(</p><p>self,name,value)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.setncattr_string">setncattr_string</a></code>
+ </p>
- <div class="desc"><p>set a netCDF dataset or group string attribute using name,value pair.
+ <div class="desc inherited"><p>set a netCDF dataset or group string attribute using name,value pair.
Use if you need to ensure that a netCDF attribute is created with type
<code>NC_STRING</code> if the file format is <code>NETCDF4</code>.</p></div>
<div class="source_cont">
@@ -5493,10 +5801,14 @@ Use if you need to ensure that a netCDF attribute is created with type
<p>def <span class="ident">setncatts</span>(</p><p>self,attdict)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.setncatts">setncatts</a></code>
+ </p>
- <div class="desc"><p>set a bunch of netCDF dataset or group attributes at once using a python dictionary.
+ <div class="desc inherited"><p>set a bunch of netCDF dataset or group attributes at once using a python dictionary.
This may be faster when setting a lot of attributes for a <code>NETCDF3</code>
formatted file, since nc_redef/nc_enddef is not called in between setting
each attribute</p></div>
@@ -5511,10 +5823,95 @@ each attribute</p></div>
<p>def <span class="ident">sync</span>(</p><p>self)</p>
</div>
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.sync">sync</a></code>
+ </p>
- <div class="desc"><p>Writes all buffered data in the <a href="#netCDF4.Dataset"><code>Dataset</code></a> to the disk file.</p></div>
+ <div class="desc inherited"><p>Writes all buffered data in the <a href="#netCDF4.Dataset"><code>Dataset</code></a> to the disk file.</p></div>
+ <div class="source_cont">
+</div>
+
+ </div>
+
+ <h3>Methods</h3>
+
+ <div class="item">
+ <div class="name def" id="netCDF4.MFDataset.__init__">
+ <p>def <span class="ident">__init__</span>(</p><p>self, files, check=False, aggdim=None, exclude=[], master_file=None)</p>
+ </div>
+
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.__init__">__init__</a></code>
+ </p>
+
+
+
+ <div class="desc"><p>Open a Dataset spanning multiple files, making it look as if it was a
+single file. Variables in the list of files that share the same
+dimension (specified with the keyword <code>aggdim</code>) are aggregated. If
+<code>aggdim</code> is not specified, the unlimited is aggregated. Currently,
+<code>aggdim</code> must be the leftmost (slowest varying) dimension of each
+of the variables to be aggregated.</p>
+<p><strong><code>files</code></strong>: either a sequence of netCDF files or a string with a
+wildcard (converted to a sorted list of files using glob) If
+the <code>master_file</code> kwarg is not specified, the first file
+in the list will become the "master" file, defining all the
+variables with an aggregation dimension which may span
+subsequent files. Attribute access returns attributes only from "master"
+file. The files are always opened in read-only mode.</p>
+<p><strong><code>check</code></strong>: True if you want to do consistency checking to ensure the
+correct variables structure for all of the netcdf files. Checking makes
+the initialization of the MFDataset instance much slower. Default is
+False.</p>
+<p><strong><code>aggdim</code></strong>: The name of the dimension to aggregate over (must
+be the leftmost dimension of each of the variables to be aggregated).
+If None (default), aggregate over the unlimited dimension.</p>
+<p><strong><code>exclude</code></strong>: A list of variable names to exclude from aggregation.
+Default is an empty list.</p>
+<p><strong><code>master_file</code></strong>: file to use as "master file", defining all the
+variables with an aggregation dimension and all global attributes.</p></div>
+ <div class="source_cont">
+</div>
+
+ </div>
+
+
+ <div class="item">
+ <div class="name def" id="netCDF4.MFDataset.close">
+ <p>def <span class="ident">close</span>(</p><p>self)</p>
+ </div>
+
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.close">close</a></code>
+ </p>
+
+
+
+ <div class="desc"><p>close all the open files.</p></div>
+ <div class="source_cont">
+</div>
+
+ </div>
+
+
+ <div class="item">
+ <div class="name def" id="netCDF4.MFDataset.ncattrs">
+ <p>def <span class="ident">ncattrs</span>(</p><p>self)</p>
+ </div>
+
+ <p class="inheritance">
+ <strong>Inheritance:</strong>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.ncattrs">ncattrs</a></code>
+ </p>
+
+
+
+ <div class="desc"><p>return the netcdf attribute names from the master file.</p></div>
<div class="source_cont">
</div>
@@ -5565,9 +5962,9 @@ time unit and/or calendar to all files.</p>
<ul class="class_list">
<li><a href="#netCDF4.MFTime">MFTime</a></li>
<li>netCDF4._netCDF4._Variable</li>
- <li>builtins.object</li>
+ <li>__builtin__.object</li>
</ul>
- <h3>Static methods</h3>
+ <h3>Methods</h3>
<div class="item">
<div class="name def" id="netCDF4.MFTime.__init__">
@@ -5577,8 +5974,7 @@ time unit and/or calendar to all files.</p>
- <div class="desc"><p><strong><code>__init__(self, time, units=None, calendar=None)</code></strong></p>
-<p>Create a time Variable with units consistent across a multifile
+ <div class="desc"><p>Create a time Variable with units consistent across a multifile
dataset.</p>
<p><strong><code>time</code></strong>: Time variable from a <a href="#netCDF4.MFDataset"><code>MFDataset</code></a>.</p>
<p><strong><code>units</code></strong>: Time units, for example, <code>'days since 1979-01-01'</code>. If <code>None</code>,
@@ -5595,7 +5991,7 @@ is present on each variable and values are unique across files raising a
<div class="item">
<div class="name def" id="netCDF4.MFTime.ncattrs">
- <p>def <span class="ident">ncattrs</span>(</p><p>self)</p>
+ <p>def <span class="ident">ncattrs</span>(</p><p>...)</p>
</div>
@@ -5609,7 +6005,7 @@ is present on each variable and values are unique across files raising a
<div class="item">
<div class="name def" id="netCDF4.MFTime.set_always_mask">
- <p>def <span class="ident">set_always_mask</span>(</p><p>self, val)</p>
+ <p>def <span class="ident">set_always_mask</span>(</p><p>...)</p>
</div>
@@ -5623,7 +6019,7 @@ is present on each variable and values are unique across files raising a
<div class="item">
<div class="name def" id="netCDF4.MFTime.set_auto_chartostring">
- <p>def <span class="ident">set_auto_chartostring</span>(</p><p>self, val)</p>
+ <p>def <span class="ident">set_auto_chartostring</span>(</p><p>...)</p>
</div>
@@ -5637,7 +6033,7 @@ is present on each variable and values are unique across files raising a
<div class="item">
<div class="name def" id="netCDF4.MFTime.set_auto_mask">
- <p>def <span class="ident">set_auto_mask</span>(</p><p>self, val)</p>
+ <p>def <span class="ident">set_auto_mask</span>(</p><p>...)</p>
</div>
@@ -5651,7 +6047,7 @@ is present on each variable and values are unique across files raising a
<div class="item">
<div class="name def" id="netCDF4.MFTime.set_auto_maskandscale">
- <p>def <span class="ident">set_auto_maskandscale</span>(</p><p>self, val)</p>
+ <p>def <span class="ident">set_auto_maskandscale</span>(</p><p>...)</p>
</div>
@@ -5665,7 +6061,7 @@ is present on each variable and values are unique across files raising a
<div class="item">
<div class="name def" id="netCDF4.MFTime.set_auto_scale">
- <p>def <span class="ident">set_auto_scale</span>(</p><p>self, val)</p>
+ <p>def <span class="ident">set_auto_scale</span>(</p><p>...)</p>
</div>
@@ -5679,7 +6075,7 @@ is present on each variable and values are unique across files raising a
<div class="item">
<div class="name def" id="netCDF4.MFTime.typecode">
- <p>def <span class="ident">typecode</span>(</p><p>self)</p>
+ <p>def <span class="ident">typecode</span>(</p><p>...)</p>
</div>
@@ -5711,7 +6107,7 @@ the user.</p></div>
<h3>Ancestors (in MRO)</h3>
<ul class="class_list">
<li><a href="#netCDF4.VLType">VLType</a></li>
- <li>builtins.object</li>
+ <li>__builtin__.object</li>
</ul>
<h3>Class variables</h3>
<div class="item">
@@ -5816,7 +6212,7 @@ behavior is similar to Fortran or Matlab, but different than numpy.</p>
<h3>Ancestors (in MRO)</h3>
<ul class="class_list">
<li><a href="#netCDF4.Variable">Variable</a></li>
- <li>builtins.object</li>
+ <li>__builtin__.object</li>
</ul>
<h3>Class variables</h3>
<div class="item">
@@ -6545,7 +6941,7 @@ slower than multiple calls to the unstrided read routine <code>nc_get_vara</code
<footer id="footer">
<p>
Documentation generated by
- <a href="https://github.com/BurntSushi/pdoc">pdoc 0.3.2.dev29</a>
+ <a href="https://github.com/BurntSushi/pdoc">pdoc 0.3.2.dev16</a>
</p>
<p>pdoc is in the public domain with the
=====================================
netCDF4/_netCDF4.pyx
=====================================
@@ -1,5 +1,5 @@
"""
-Version 1.4.3
+Version 1.5.0.1
-------------
- - -
@@ -1190,7 +1190,7 @@ except ImportError:
# python3: zip is already python2's itertools.izip
pass
-__version__ = "1.5.0"
+__version__ = "1.5.0.1"
# Initialize numpy
import posixpath
@@ -2006,14 +2006,14 @@ strings.
`netCDF4.Dataset` constructor.
**`filename`**: Name of netCDF file to hold dataset. Can also
- be a python 3 pathlib instance or the URL of an OpenDAP dataset. When memory is
- set this is just used to set the `filepath()`.
+ be a python 3 pathlib instance or the URL of an OpenDAP dataset. When memory is
+ set this is just used to set the `filepath()`.
**`mode`**: access mode. `r` means read-only; no data can be
modified. `w` means write; a new file is created, an existing file with
the same name is deleted. `a` and `r+` mean append (in analogy with
serial files); an existing file is opened for reading and writing.
- Appending `s` to modes `w`, `r+` or `a` will enable unbuffered shared
+ Appending `s` to modes `r`, `w`, `r+` or `a` will enable unbuffered shared
access to `NETCDF3_CLASSIC`, `NETCDF3_64BIT_OFFSET` or
`NETCDF3_64BIT_DATA` formatted files.
Unbuffered access may be useful even if you don't need shared
@@ -2200,7 +2200,7 @@ strings.
# **this causes parallel mode to fail when both hdf5-parallel and
# pnetcdf are enabled - issue #820 **
#_set_default_format(format='NETCDF3_64BIT_OFFSET')
- elif mode == 'r':
+ elif mode in ('r', 'rs'):
if memory is not None:
IF HAS_NC_OPEN_MEM:
# Store reference to memory
@@ -2223,7 +2223,13 @@ strings.
elif diskless:
ierr = nc_open(path, NC_NOWRITE | NC_DISKLESS, &grpid)
else:
- ierr = nc_open(path, NC_NOWRITE, &grpid)
+ if mode == 'rs':
+ # NC_SHARE is very important for speed reading
+ # large netcdf3 files with a record dimension
+ # (pull request #902).
+ ierr = nc_open(path, NC_NOWRITE | NC_SHARE, &grpid)
+ else:
+ ierr = nc_open(path, NC_NOWRITE, &grpid)
elif mode == 'r+' or mode == 'a':
if parallel:
IF HAS_PARALLEL4_SUPPORT or HAS_PNETCDF_SUPPORT:
=====================================
setup.py
=====================================
@@ -584,7 +584,7 @@ else:
setup(name="netCDF4",
cmdclass=cmdclass,
- version="1.5.0",
+ version="1.5.0.1",
long_description="netCDF version 4 has many features not found in earlier versions of the library, such as hierarchical groups, zlib compression, multiple unlimited dimensions, and new data types. It is implemented on top of HDF5. This module implements most of the new features, and can read and write netCDF files compatible with older versions of the library. The API is modelled after Scientific.IO.NetCDF, and should be familiar to users of that module.\n\nThis project is hosted on a `GitHub repository <https://github.com/Unidata/netcdf4-python>`_ where you may access the most up-to-date source.",
author="Jeff Whitaker",
author_email="jeffrey.s.whitaker at noaa.gov",
View it on GitLab: https://salsa.debian.org/debian-gis-team/netcdf4-python/commit/53bbcc5c63b3d0d42ee74141f203954e0e3aa8d1
--
View it on GitLab: https://salsa.debian.org/debian-gis-team/netcdf4-python/commit/53bbcc5c63b3d0d42ee74141f203954e0e3aa8d1
You're receiving this email because of your account on salsa.debian.org.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://alioth-lists.debian.net/pipermail/pkg-grass-devel/attachments/20190402/bf5649bf/attachment-0001.html>
More information about the Pkg-grass-devel
mailing list