[Git][debian-gis-team/netcdf4-python][upstream] New upstream version 1.5.1
Bas Couwenberg
gitlab at salsa.debian.org
Tue Apr 30 05:59:51 BST 2019
Bas Couwenberg pushed to branch upstream at Debian GIS Project / netcdf4-python
Commits:
7dd73974 by Bas Couwenberg at 2019-04-30T04:40:22Z
New upstream version 1.5.1
- - - - -
14 changed files:
- Changelog
- − PKG-INFO
- README.md
- docs/netCDF4/index.html
- netCDF4/_netCDF4.pyx
- netCDF4/utils.py
- setup.py
- + test/CRM032_test1.nc
- test/run_all.py
- + test/test_gold.nc
- test/tst_atts.py
- + test/tst_issue908.py
- test/tst_scaled.py
- test/tst_slicing.py
Changes:
=====================================
Changelog
=====================================
@@ -1,3 +1,13 @@
+ version 1.5.1 (tag v1.5.1rel)
+==============================
+ * fix issue #908 by adding workaround for incorrect value returned
+ by nc_inq_var_fill for netcdf-c < 4.5.1.
+ * fix bug writing slice to unlimited dimension that is not the first
+ (leftmost). Issue #906.
+ * make sure data gets converted to type of scale_factor when add_offset=0
+ and scale_factor=1 (issue #913).
+ * fix for reading empty (NIL) string attributes (issue #915).
+
version 1.5.0.1 (tag v1.5.0.1rel)
==================================
* binary wheels for linux and macosx rebuilt against netcdf-c 4.6.3 (instead
=====================================
PKG-INFO deleted
=====================================
@@ -1,47 +0,0 @@
-Metadata-Version: 1.1
-Name: netCDF4
-Version: 1.5.0
-Author: Jeff Whitaker
-Author-email: jeffrey s whitaker at noaa gov
-Home-page: https://github.com/Unidata/netcdf4-python
-Summary: python/numpy interface to netCDF library (versions 3 and 4)
-License: OSI Approved
-Description: netCDF version 4 has many features not found in earlier versions of the library
- and is implemented on
- top of HDF5. This module can read and write files in both the new netCDF 4 and
- the old netCDF 3
- format, and can create files that are readable by HDF5 clients. The API modelled
- after
- Scientific.IO.NetCDF, and should be familiar to users of that module.
-
- Most new features of netCDF 4 are implemented, such as multiple unlimited
- dimensions, groups and zlib data compression. All the new numeric data types
- (such as 64 bit and unsigned integer types) are implemented. Compound,
- variable length (vlen), and enumerated (enum) data types are supported, but
- the opaque type is not. Mixtures of compound, vlen and/or enum data types are not supported.
-
- This project has a `Github repository
- <https://github.com/Unidata/netcdf4-python>`_ where you may access
- the most
- up-to-date source.
-
- `Documentation
- <http://unidata.github.io/netcdf4-python>`_
-
- `Changelog
- <https://github.com/Unidata/netcdf4-python/blob/master/Changelog>`_
-
- Also available in the `Anaconda scientific python distribution <https://store.continuum.io/cshop/anaconda/>`_
-
- Download source tarball and binary wheels below...
-Keywords: numpy netcdf data science network oceanography meteorology climate
-Platform: any
-Classifier: Intended Audience :: Science/Research
-Classifier: Programming Language :: Python :: 2
-Classifier: Programming Language :: Python :: 2.7
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.3
-Classifier: Programming Language :: Python :: 3.4
-Classifier: Programming Language :: Python :: 3.5
-Classifier: Topic :: Scientific/Engineering
-
=====================================
README.md
=====================================
@@ -10,6 +10,8 @@
## News
For details on the latest updates, see the [Changelog](https://github.com/Unidata/netcdf4-python/blob/master/Changelog).
+04/30/2019: Version [1.5.1](https://pypi.python.org/pypi/netCDF4/1.5.1) released. Bugfixes, no new features.
+
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').
=====================================
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.5.0
+ <meta name="description" content="Version 1.5.1
-------------
- - -
@@ -1174,6 +1174,8 @@ 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>
@@ -1185,6 +1187,7 @@ 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>
@@ -1201,9 +1204,6 @@ 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.5.0</h2>
+ <h2>Version 1.5.1</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>__builtin__.object</li>
+ <li>builtins.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>__builtin__.object</li>
+ <li>builtins.object</li>
</ul>
<h3>Class variables</h3>
<div class="item">
@@ -2929,7 +2929,7 @@ set this is just used to set the <code>filepath()</code>.</p>
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.
-Appending <code>s</code> to modes <code>w</code>, <code>r+</code> or <code>a</code> will enable unbuffered shared
+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.
Unbuffered access may be useful even if you don't need shared
@@ -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>__builtin__.object</li>
+ <li>builtins.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>__builtin__.object</li>
+ <li>builtins.object</li>
</ul>
<h3>Class variables</h3>
<div class="item">
@@ -3860,22 +3860,15 @@ 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>__builtin__.object</li>
+ <li>builtins.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>
@@ -3883,16 +3876,9 @@ compound types defined for the <a href="#netCDF4.Group"><code>Group</code></a> o
<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>
@@ -3900,16 +3886,9 @@ data model version, one of <code>NETCDF3_CLASSIC</code>, <code>NETCDF4</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>
@@ -3917,18 +3896,9 @@ dimensions defined for the <a href="#netCDF4.Group"><code>Group</code></a> or <a
<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>
@@ -3936,16 +3906,9 @@ netcdf C library version >= 4.3.1, otherwise will always return
<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>
@@ -3953,14 +3916,9 @@ Enum types defined for the <a href="#netCDF4.Group"><code>Group</code></a> or <a
<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>
@@ -3968,17 +3926,9 @@ Enum types defined for the <a href="#netCDF4.Group"><code>Group</code></a> or <a
<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>
@@ -3986,15 +3936,9 @@ describes the root group in the netCDF4 file).</p></div>
<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>
@@ -4013,15 +3957,9 @@ the parent Dataset or Group.</p></div>
<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>
@@ -4029,17 +3967,9 @@ the parent Dataset or Group.</p></div>
<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>
@@ -4047,16 +3977,9 @@ group, so the path is simply <code>'/'</code>.</p></div>
<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>
@@ -4064,16 +3987,9 @@ class.</p></div>
<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>
@@ -4110,10 +4026,6 @@ 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>
@@ -4130,14 +4042,10 @@ 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 inherited"><p>Creates a new compound data type named <code>datatype_name</code> from the numpy
+ <div class="desc"><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
@@ -4156,14 +4064,10 @@ 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 inherited"><p>Creates a new dimension with the given <code>dimname</code> and <code>size</code>.</p>
+ <div class="desc"><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>
@@ -4182,14 +4086,10 @@ 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 inherited"><p>Creates a new Enum data type named <code>datatype_name</code> from a numpy
+ <div class="desc"><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
@@ -4205,14 +4105,10 @@ 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 inherited"><p>Creates a new <a href="#netCDF4.Group"><code>Group</code></a> with the given <code>groupname</code>.</p>
+ <div class="desc"><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,
@@ -4232,14 +4128,10 @@ 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 inherited"><p>Creates a new VLEN data type named <code>datatype_name</code> from a numpy
+ <div class="desc"><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>
@@ -4254,14 +4146,10 @@ 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 inherited"><p>Creates a new variable with the given <code>varname</code>, <code>datatype</code>, and
+ <div class="desc"><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
@@ -4371,14 +4259,10 @@ 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 inherited"><p>delete a netCDF dataset or group attribute. Use if you need to delete a
+ <div class="desc"><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">
@@ -4392,14 +4276,10 @@ 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 inherited"><p>Get the file system path (or the opendap URL) which was used to
+ <div class="desc"><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>
@@ -4414,14 +4294,10 @@ 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 inherited"><p>Returns a list of variables that match specific conditions.</p>
+ <div class="desc"><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>
@@ -4453,14 +4329,10 @@ 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 inherited"><p>retrieve a netCDF dataset or group attribute.
+ <div class="desc"><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
@@ -4476,14 +4348,10 @@ 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 inherited"><p>is the Dataset open or closed?</p></div>
+ <div class="desc"><p>is the Dataset open or closed?</p></div>
<div class="source_cont">
</div>
@@ -4495,14 +4363,10 @@ 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 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="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="source_cont">
</div>
@@ -4514,14 +4378,10 @@ 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 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="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="source_cont">
</div>
@@ -4533,14 +4393,10 @@ 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 inherited"><p>rename a <a href="#netCDF4.Dimension"><code>Dimension</code></a> named <code>oldname</code> to <code>newname</code>.</p></div>
+ <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="source_cont">
</div>
@@ -4552,14 +4408,10 @@ 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 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="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="source_cont">
</div>
@@ -4571,14 +4423,10 @@ 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 inherited"><p>rename a <a href="#netCDF4.Variable"><code>Variable</code></a> named <code>oldname</code> to <code>newname</code></p></div>
+ <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="source_cont">
</div>
@@ -4590,14 +4438,10 @@ 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 inherited"><p>Call <a href="#netCDF4.Variable.set_always_mask"><code>set_always_mask</code></a> for all variables contained in
+ <div class="desc"><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
@@ -4617,14 +4461,10 @@ 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 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
+ <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
<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
@@ -4643,14 +4483,10 @@ 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 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
+ <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
<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>
@@ -4667,14 +4503,10 @@ 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 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
+ <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
<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>
@@ -4691,14 +4523,10 @@ 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 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
+ <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
<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>
@@ -4715,14 +4543,10 @@ 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 inherited"><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"><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>
@@ -4737,14 +4561,10 @@ 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 inherited"><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"><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
@@ -4763,14 +4583,10 @@ 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 inherited"><p>Call <a href="#netCDF4.Variable.set_ncstring_attrs"><code>set_ncstring_attrs</code></a> for all variables contained in
+ <div class="desc"><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
@@ -4789,14 +4605,10 @@ 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 inherited"><p>set a netCDF dataset or group attribute using name,value pair.
+ <div class="desc"><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">
@@ -4810,14 +4622,10 @@ 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 inherited"><p>set a netCDF dataset or group string attribute using name,value pair.
+ <div class="desc"><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">
@@ -4831,14 +4639,10 @@ 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 inherited"><p>set a bunch of netCDF dataset or group attributes at once using a python dictionary.
+ <div class="desc"><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>
@@ -4853,14 +4657,10 @@ 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 inherited"><p>Writes all buffered data in the <a href="#netCDF4.Dataset"><code>Dataset</code></a> to the disk file.</p></div>
+ <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="source_cont">
</div>
@@ -4905,22 +4705,15 @@ 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>__builtin__.object</li>
+ <li>builtins.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>
@@ -4928,16 +4721,9 @@ compound types defined for the <a href="#netCDF4.Group"><code>Group</code></a> o
<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>
@@ -4945,16 +4731,9 @@ data model version, one of <code>NETCDF3_CLASSIC</code>, <code>NETCDF4</code>,
<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>
@@ -4962,18 +4741,9 @@ dimensions defined for the <a href="#netCDF4.Group"><code>Group</code></a> or <a
<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>
@@ -4981,16 +4751,9 @@ netcdf C library version >= 4.3.1, otherwise will always return
<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>
@@ -4998,14 +4761,9 @@ Enum types defined for the <a href="#netCDF4.Group"><code>Group</code></a> or <a
<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>
@@ -5013,17 +4771,9 @@ Enum types defined for the <a href="#netCDF4.Group"><code>Group</code></a> or <a
<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>
@@ -5031,15 +4781,9 @@ describes the root group in the netCDF4 file).</p></div>
<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>
@@ -5047,15 +4791,9 @@ the parent Dataset or Group.</p></div>
<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>
@@ -5063,17 +4801,9 @@ the parent Dataset or Group.</p></div>
<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>
@@ -5081,16 +4811,9 @@ group, so the path is simply <code>'/'</code>.</p></div>
<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>
@@ -5098,16 +4821,9 @@ class.</p></div>
<div class="item">
<p id="netCDF4.MFDataset.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>
@@ -5115,18 +4831,74 @@ variable-length types defined for the <a href="#netCDF4.Group"><code>Group</code
<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 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.createCompoundType">createCompoundType</a></code>
+ <code><a href="#netCDF4.Dataset">Dataset</a></code>.<code><a href="#netCDF4.Dataset.__init__">__init__</a></code>
</p>
- <div class="desc inherited"><p>Creates a new compound data type named <code>datatype_name</code> from the numpy
+ <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="source_cont">
+</div>
+
+ </div>
+
+
+ <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>
+
+
+
+
+ <div class="desc"><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
@@ -5145,14 +4917,10 @@ 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 inherited"><p>Creates a new dimension with the given <code>dimname</code> and <code>size</code>.</p>
+ <div class="desc"><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>
@@ -5171,14 +4939,10 @@ 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 inherited"><p>Creates a new Enum data type named <code>datatype_name</code> from a numpy
+ <div class="desc"><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
@@ -5194,14 +4958,10 @@ 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 inherited"><p>Creates a new <a href="#netCDF4.Group"><code>Group</code></a> with the given <code>groupname</code>.</p>
+ <div class="desc"><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,
@@ -5221,14 +4981,10 @@ 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 inherited"><p>Creates a new VLEN data type named <code>datatype_name</code> from a numpy
+ <div class="desc"><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>
@@ -5243,14 +4999,10 @@ 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 inherited"><p>Creates a new variable with the given <code>varname</code>, <code>datatype</code>, and
+ <div class="desc"><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
@@ -5360,14 +5112,10 @@ 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 inherited"><p>delete a netCDF dataset or group attribute. Use if you need to delete a
+ <div class="desc"><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">
@@ -5381,14 +5129,10 @@ 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 inherited"><p>Get the file system path (or the opendap URL) which was used to
+ <div class="desc"><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>
@@ -5403,14 +5147,10 @@ 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 inherited"><p>Returns a list of variables that match specific conditions.</p>
+ <div class="desc"><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>
@@ -5442,14 +5182,10 @@ 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 inherited"><p>retrieve a netCDF dataset or group attribute.
+ <div class="desc"><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
@@ -5465,14 +5201,26 @@ 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 inherited"><p>is the Dataset open or closed?</p></div>
+ <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="source_cont">
</div>
@@ -5484,14 +5232,10 @@ 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 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="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="source_cont">
</div>
@@ -5503,14 +5247,10 @@ 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 inherited"><p>rename a <a href="#netCDF4.Dimension"><code>Dimension</code></a> named <code>oldname</code> to <code>newname</code>.</p></div>
+ <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="source_cont">
</div>
@@ -5522,14 +5262,10 @@ 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 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="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="source_cont">
</div>
@@ -5541,14 +5277,10 @@ 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 inherited"><p>rename a <a href="#netCDF4.Variable"><code>Variable</code></a> named <code>oldname</code> to <code>newname</code></p></div>
+ <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="source_cont">
</div>
@@ -5560,14 +5292,10 @@ 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 inherited"><p>Call <a href="#netCDF4.Variable.set_always_mask"><code>set_always_mask</code></a> for all variables contained in
+ <div class="desc"><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
@@ -5587,14 +5315,10 @@ 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 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
+ <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
<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
@@ -5613,14 +5337,10 @@ 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 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
+ <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
<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>
@@ -5637,14 +5357,10 @@ 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 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
+ <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
<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>
@@ -5661,14 +5377,10 @@ 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 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
+ <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
<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>
@@ -5685,14 +5397,10 @@ 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 inherited"><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"><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>
@@ -5707,14 +5415,10 @@ 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 inherited"><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"><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
@@ -5733,14 +5437,10 @@ 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 inherited"><p>Call <a href="#netCDF4.Variable.set_ncstring_attrs"><code>set_ncstring_attrs</code></a> for all variables contained in
+ <div class="desc"><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
@@ -5759,14 +5459,10 @@ 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 inherited"><p>set a netCDF dataset or group attribute using name,value pair.
+ <div class="desc"><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">
@@ -5780,14 +5476,10 @@ 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 inherited"><p>set a netCDF dataset or group string attribute using name,value pair.
+ <div class="desc"><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">
@@ -5801,14 +5493,10 @@ 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 inherited"><p>set a bunch of netCDF dataset or group attributes at once using a python dictionary.
+ <div class="desc"><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>
@@ -5823,95 +5511,10 @@ 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 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="desc"><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>
@@ -5962,9 +5565,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>__builtin__.object</li>
+ <li>builtins.object</li>
</ul>
- <h3>Methods</h3>
+ <h3>Static methods</h3>
<div class="item">
<div class="name def" id="netCDF4.MFTime.__init__">
@@ -5974,7 +5577,8 @@ time unit and/or calendar to all files.</p>
- <div class="desc"><p>Create a time Variable with units consistent across a multifile
+ <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
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>,
@@ -5991,7 +5595,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>...)</p>
+ <p>def <span class="ident">ncattrs</span>(</p><p>self)</p>
</div>
@@ -6005,7 +5609,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>...)</p>
+ <p>def <span class="ident">set_always_mask</span>(</p><p>self, val)</p>
</div>
@@ -6019,7 +5623,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>...)</p>
+ <p>def <span class="ident">set_auto_chartostring</span>(</p><p>self, val)</p>
</div>
@@ -6033,7 +5637,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>...)</p>
+ <p>def <span class="ident">set_auto_mask</span>(</p><p>self, val)</p>
</div>
@@ -6047,7 +5651,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>...)</p>
+ <p>def <span class="ident">set_auto_maskandscale</span>(</p><p>self, val)</p>
</div>
@@ -6061,7 +5665,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>...)</p>
+ <p>def <span class="ident">set_auto_scale</span>(</p><p>self, val)</p>
</div>
@@ -6075,7 +5679,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>...)</p>
+ <p>def <span class="ident">typecode</span>(</p><p>self)</p>
</div>
@@ -6107,7 +5711,7 @@ the user.</p></div>
<h3>Ancestors (in MRO)</h3>
<ul class="class_list">
<li><a href="#netCDF4.VLType">VLType</a></li>
- <li>__builtin__.object</li>
+ <li>builtins.object</li>
</ul>
<h3>Class variables</h3>
<div class="item">
@@ -6212,7 +5816,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>__builtin__.object</li>
+ <li>builtins.object</li>
</ul>
<h3>Class variables</h3>
<div class="item">
@@ -6941,7 +6545,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.dev16</a>
+ <a href="https://github.com/BurntSushi/pdoc">pdoc 0.3.2.dev29</a>
</p>
<p>pdoc is in the public domain with the
=====================================
netCDF4/_netCDF4.pyx
=====================================
@@ -1,5 +1,5 @@
"""
-Version 1.5.0.1
+Version 1.5.1
-------------
- - -
@@ -1414,7 +1414,7 @@ cdef _get_att(grp, int varid, name, encoding='utf-8'):
_ensure_nc_success(ierr, err_cls=AttributeError)
try:
result = [values[j].decode(encoding,errors='replace').replace('\x00','')
- for j in range(att_len)]
+ if values[j] else "" for j in range(att_len)]
finally:
ierr = nc_free_string(att_len, values) # free memory in netcdf C lib
finally:
@@ -3937,9 +3937,16 @@ behavior is similar to Fortran or Matlab, but different than numpy.
if (self._grp.path != '/'): ncdump_var.append('path = %s\n' % self._grp.path)
ncdump_var.append('unlimited dimensions: %s\n' % ', '.join(unlimdims))
ncdump_var.append('current shape = %s\n' % repr(self.shape))
- with nogil:
- ierr = nc_inq_var_fill(self._grpid,self._varid,&no_fill,NULL)
- _ensure_nc_success(ierr)
+ if __netcdf4libversion__ < '4.5.1' and\
+ self._grp.file_format.startswith('NETCDF3'):
+ # issue #908: no_fill not correct for NETCDF3 files before 4.5.1
+ # before 4.5.1 there was no way to turn off filling on a
+ # per-variable basis for classic files.
+ no_fill=0
+ else:
+ with nogil:
+ ierr = nc_inq_var_fill(self._grpid,self._varid,&no_fill,NULL)
+ _ensure_nc_success(ierr)
if self._isprimitive:
if no_fill != 1:
try:
@@ -4389,14 +4396,17 @@ rename a `netCDF4.Variable` attribute named `oldname` to `newname`."""
data = data.view('u%s' % data.dtype.itemsize)
if self.scale and self._isprimitive and valid_scaleoffset:
- # if variable has scale_factor and add_offset attributes, rescale.
- if hasattr(self, 'scale_factor') and hasattr(self, 'add_offset') and\
- (self.add_offset != 0.0 or self.scale_factor != 1.0):
- data = data*self.scale_factor + self.add_offset
- # else if variable has only scale_factor attributes, rescale.
+ # if variable has scale_factor and add_offset attributes, apply
+ # them.
+ if hasattr(self, 'scale_factor') and hasattr(self, 'add_offset'):
+ if self.add_offset != 0.0 or self.scale_factor != 1.0:
+ data = data*self.scale_factor + self.add_offset
+ else:
+ data = data.astype(self.scale_factor.dtype) # issue 913
+ # else if variable has only scale_factor attribute, rescale.
elif hasattr(self, 'scale_factor') and self.scale_factor != 1.0:
data = data*self.scale_factor
- # else if variable has only add_offset attributes, rescale.
+ # else if variable has only add_offset attribute, add offset.
elif hasattr(self, 'add_offset') and self.add_offset != 0.0:
data = data + self.add_offset
@@ -4492,9 +4502,16 @@ rename a `netCDF4.Variable` attribute named `oldname` to `newname`."""
# issue 209: don't return masked array if variable filling
# is disabled.
else:
- with nogil:
- ierr = nc_inq_var_fill(self._grpid,self._varid,&no_fill,NULL)
- _ensure_nc_success(ierr)
+ if __netcdf4libversion__ < '4.5.1' and\
+ self._grp.file_format.startswith('NETCDF3'):
+ # issue #908: no_fill not correct for NETCDF3 files before 4.5.1
+ # before 4.5.1 there was no way to turn off filling on a
+ # per-variable basis for classic files.
+ no_fill=0
+ else:
+ with nogil:
+ ierr = nc_inq_var_fill(self._grpid,self._varid,&no_fill,NULL)
+ _ensure_nc_success(ierr)
# if no_fill is not 1, and not a byte variable, then use default fill value.
# from http://www.unidata.ucar.edu/software/netcdf/docs/netcdf-c/Fill-Values.html#Fill-Values
# "If you need a fill value for a byte variable, it is recommended
@@ -5304,7 +5321,10 @@ NC_CHAR).
# not given, use 'utf-8'.
encoding = getattr(self,'_Encoding','utf-8')
for i from 0<=i<totelem:
- data[i] = strdata[i].decode(encoding)
+ if strdata[i]:
+ data[i] = strdata[i].decode(encoding)
+ else:
+ data[i] = "" # issue 915
# reshape the output array
data = numpy.reshape(data, shapeout)
# free string data internally allocated in netcdf C lib
=====================================
netCDF4/utils.py
=====================================
@@ -139,7 +139,7 @@ def _StartCountStride(elem, shape, dimensions=None, grp=None, datashape=None,\
grp : netCDF Group
The netCDF group to which the variable being set belongs to.
datashape : sequence
- The shape of the data that is being stored. Only needed by __setitime__
+ The shape of the data that is being stored. Only needed by __setitem__
put : True|False (default False). If called from __setitem__, put is True.
Returns
@@ -342,6 +342,17 @@ Boolean array must have the same shape as the data along this dimension."""
else:
sdim.append(1)
+ # pad datashape with zeros for dimensions not being sliced
+ if datashape:
+ datashapenew = (); i=0
+ for e in elem:
+ if type(e) != slice:
+ datashapenew = datashapenew + (0,)
+ else:
+ datashapenew = datashapenew + (datashape[i],)
+ i+=1
+ datashape = datashapenew
+
# Create the start, count, stride and indices arrays.
sdim.append(max(nDims, 1))
=====================================
setup.py
=====================================
@@ -584,7 +584,7 @@ else:
setup(name="netCDF4",
cmdclass=cmdclass,
- version="1.5.0.1",
+ version="1.5.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",
=====================================
test/CRM032_test1.nc
=====================================
Binary files /dev/null and b/test/CRM032_test1.nc differ
=====================================
test/run_all.py
=====================================
@@ -38,7 +38,6 @@ else:
test_files.remove('tst_dap.py')
test_files.insert(0,'tst_dap.py')
-
# Build the test suite from the tests found in the test files.
testsuite = unittest.TestSuite()
for f in test_files:
=====================================
test/test_gold.nc
=====================================
Binary files /dev/null and b/test/test_gold.nc differ
=====================================
test/tst_atts.py
=====================================
@@ -219,6 +219,10 @@ class VariablesTestCase(unittest.TestCase):
assert v1.stringseqatt_array == STRINGSEQATT
assert getattr(v1,'nonexistantatt',None) == None
f.close()
+ # issue 915 empty string attribute (ncdump reports 'NIL')
+ f = netCDF4.Dataset('test_gold.nc')
+ assert f['RADIANCE'].VAR_NOTES == ""
+ f.close()
if __name__ == '__main__':
unittest.main()
=====================================
test/tst_issue908.py
=====================================
@@ -0,0 +1,18 @@
+import netCDF4, unittest
+import numpy as np
+
+class Issue908TestCase(unittest.TestCase):
+
+ def setUp(self):
+ nc = netCDF4.Dataset('CRM032_test1.nc')
+ self.nc = nc
+
+ def tearDown(self):
+ self.nc.close()
+
+ def runTest(self):
+ data = self.nc['rgrid'][:]
+ assert(data.all() is np.ma.masked)
+
+if __name__ == '__main__':
+ unittest.main()
=====================================
test/tst_scaled.py
=====================================
@@ -33,9 +33,13 @@ class SetAutoScaleTestBase(unittest.TestCase):
f = Dataset(self.testfile, 'w')
x = f.createDimension('x', None)
+ xx = f.createDimension('xx', 10)
v = f.createVariable('v', "i2", 'x')
+ vv = f.createVariable('vv', "i2", 'xx')
+ vv.add_offset=0; vv.scale_factor=np.float32(1.0)
v[:] = self.v
+ vv[:] = np.ones(10)
# Note: Scale factors are only added after writing, so that no auto-scaling takes place!
@@ -106,6 +110,11 @@ class SetAutoScaleTrue(SetAutoScaleTestBase):
f.variables["v"].set_auto_scale(True) # The default anyway...
v_scaled = f.variables['v'][:]
+ # issue 913
+ vv_scaled = f.variables['vv'][:]
+ self.assertEqual(vv_scaled.dtype,f.variables['vv'].scale_factor.dtype)
+ assert_array_almost_equal(vv_scaled, np.ones(10))
+
self.assertEqual(v_scaled.dtype, "f8")
self.assertTrue(isinstance(v_scaled, np.ndarray))
# issue 785: always return masked array by default
=====================================
test/tst_slicing.py
=====================================
@@ -211,5 +211,16 @@ class VariablesTestCase(unittest.TestCase):
assert_array_equal(data,data2)
nc.close()
+ def test_issue906(self):
+ f = Dataset('test.nc','w')
+ f.createDimension('d1',3)
+ f.createDimension('d2',None)
+ f.createDimension('d3',5)
+ f.createVariable('v2',np.float,('d1','d2','d3'))
+ f['v2'][:] = np.zeros((3,4,5))
+ f['v2'][0,:,0] = np.arange(4)
+ f['v2'][0,:,:] = np.ones((4,5))
+ f.close()
+
if __name__ == '__main__':
unittest.main()
View it on GitLab: https://salsa.debian.org/debian-gis-team/netcdf4-python/commit/7dd73974f3cbce190975d4f91cb1f02eddbd240d
--
View it on GitLab: https://salsa.debian.org/debian-gis-team/netcdf4-python/commit/7dd73974f3cbce190975d4f91cb1f02eddbd240d
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/20190430/411c22c3/attachment-0001.html>
More information about the Pkg-grass-devel
mailing list