update 1.2.1

EUFAR · Dec 17, 2019 · bc9397b · bc9397b
1 parent 3098d79
commit bc9397b
Show file tree

Hide file tree

Showing 13 changed files with 38 additions and 10 deletions.
diff --git a/Documentation/EGADS Algorithm Handbook - LATEX/cover/alg_cover.tex b/Documentation/EGADS Algorithm Handbook - LATEX/cover/alg_cover.tex
@@ -24,7 +24,7 @@
 \setlength{\voffset}{.0cm}
 
 \logoeufar
-\title{EUFAR, Olivier Henry}{}{EGADS Lineage Algorithm Handbook}{Version 1.2.0}
+\title{EUFAR, Olivier Henry}{}{EGADS Lineage Algorithm Handbook}{Version 1.2.1}
 %\author{}{}
 
 

diff --git a/...S Lineage Algorithm Handbook - v1.2.0.pdf → ...S Lineage Algorithm Handbook - v1.2.1.pdf b/...S Lineage Algorithm Handbook - v1.2.0.pdf → ...S Lineage Algorithm Handbook - v1.2.1.pdf
diff --git a/.../EGADS Lineage Documentation - v1.2.0.pdf → .../EGADS Lineage Documentation - v1.2.1.pdf b/.../EGADS Lineage Documentation - v1.2.0.pdf → .../EGADS Lineage Documentation - v1.2.1.pdf
diff --git a/Documentation/changelog.txt b/Documentation/changelog.txt
@@ -10,6 +10,15 @@ To fix list:
 ------------
 
 
+December 17 2019, Release version 1.2.1
+=======================================
+  ADDED:
+    - an attribute has been added to EgadsData object when reading a variable in a HDF5 file including compound data. Read the documentation for more details.
+
+  MODIFIED:
+    - the documentation has been updated to take into account the specificity of compound data in HDF dataset.
+
+
 December 11 2019, Release version 1.2.0
 =======================================
 EGADS can read and write HDF5 file format, following or not EUFAR convention.

diff --git a/PKG-INFO b/PKG-INFO
@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: egads-lineage
-Version: 1.2.0
+Version: 1.2.1
 Summary: EGADS: EUFAR General Airborne Data-processing Software
 Home-page: https://github.com/EUFAR/egads/tree/Lineage
 Author: EUFAR, Olivier Henry

diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 Version:
 -------
 
-EGADS Lineage 1.2.0
+EGADS Lineage 1.2.1
 
 
 Developments:

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -48,9 +48,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '1.2.0'
+version = '1.2.1'
 # The full version, including alpha/beta/rc tags.
-release = '1.2.0'
+release = '1.2.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/doc/source/tutorial-hdf.inc b/doc/source/tutorial-hdf.inc
@@ -246,6 +246,21 @@ To close a file, simply use the ``close()`` method:
     >>> f.close()
 
 
+Dataset with compound data
+--------------------------
+
+Dataset with compound data are not specifically handled by EGADS. When a dataset is read and contains compound data, it is possible to access the different fields in this way:
+
+    >>> temperature = f.read_variable('temperature')
+    >>> date_field = temperature['date']
+
+Obviously, if the user declared an EgadsHdf instance to read the file, the compound data is still an EgadsData instance, with the same metadata and units. If the user declared an Hdf instance to read the file, the compound data is a Numpy ndarray instance.
+In EGADS, units are handled automatically. Thus, with compound data and multiple data in the same dataset, it is highly likely that units won't be handled properly, and will be set to dimensionless most of the time.
+
+.. NOTE::
+  With the instance EgadsHdf, an attribute has been added to the EgadsData instance, ``compound_data``, which informs the user about the dataset type. If the dataset contains compound data, the attribute ``compound_data`` is set to ``True`` ; if not it is set to ``False``. Then it is the responsability of the user to explore the different fields in the dataset.
+
+
 Tutorial
 ---------
 

diff --git a/egads/_version.py b/egads/_version.py
@@ -1,2 +1,2 @@
-__version__ = '1.2.0'
+__version__ = '1.2.1'
 __branch__ = 'Lineage'
diff --git a/egads/input/hdf_io.py b/egads/input/hdf_io.py
@@ -767,6 +767,10 @@ def _read_variable(self, varname, input_range, read_as_float, replace_fill_value
 
             variable_metadata = egads.core.metadata.VariableMetadata(var_attrs, self.file_metadata)
             data = egads.EgadsData(var, variable_metadata=variable_metadata)
+            if len(var.dtype) > 1:
+                data.compound_data = True
+            else:
+                data.compound_data = False
             logging.debug('egads - hdf_io.py - EgadsHdf - _read_variable - varname ' + str(varname)
                           + ' -> data read OK')
             return data

diff --git a/egads_lineage.egg-info/PKG-INFO b/egads_lineage.egg-info/PKG-INFO
@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: egads-lineage
-Version: 1.2.0
+Version: 1.2.1
 Summary: EGADS: EUFAR General Airborne Data-processing Software
 Home-page: https://github.com/EUFAR/egads/tree/Lineage
 Author: EUFAR, Olivier Henry

diff --git a/egads_lineage.egg-info/SOURCES.txt b/egads_lineage.egg-info/SOURCES.txt
@@ -3,8 +3,8 @@ MANIFEST.in
 README.md
 setup.cfg
 setup.py
-Documentation/EGADS Lineage Algorithm Handbook - v1.2.0.pdf
-Documentation/EGADS Lineage Documentation - v1.2.0.pdf
+Documentation/EGADS Lineage Algorithm Handbook - v1.2.1.pdf
+Documentation/EGADS Lineage Documentation - v1.2.1.pdf
 Documentation/changelog.txt
 Documentation/EGADS Algorithm Handbook - LATEX/EGADS_alg_doc.tex
 Documentation/EGADS Algorithm Handbook - LATEX/example.py

diff --git a/setup.py b/setup.py
@@ -30,7 +30,7 @@
 doclines = __doc__.split('\n')
 
 setup(name='egads-lineage',
-      version='1.2.0',
+      version='1.2.1',
       description=doclines[0],
       long_description='\n'.join(doclines[2:]),
       author='EUFAR, Olivier Henry',