Merge pull request #271 from johntruckenbrodt/version/0.22.2

version 0.22.2 changelog and documentation updates
johntruckenbrodt · Nov 16, 2023 · d4d5c1f · d4d5c1f
2 parents 46e0a2f + 67dcd8d
commit d4d5c1f
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 0 deletions.
diff --git a/docs/source/about/changelog.rst b/docs/source/about/changelog.rst
@@ -959,3 +959,18 @@ Drivers
 -------
 - class :class:`pyroSAR.drivers.BEAM_DIMAP`: enable calling inherited method :meth:`~pyroSAR.drivers.ID.geometry`
 
+0.22.2 | 2023-11-16
+===================
+
+SNAP API
+--------
+- function :func:`pyroSAR.snap.auxil.writer`: fixed bug in ignoring `erode_edges` argument
+- function :func:`pyroSAR.snap.auxil.erode_edges`: enable handling of polarimetric matrices
+
+Drivers
+-------
+- function :func:`pyroSAR.drivers.identify`: enable reading of :class:`~pyroSAR.drivers.TDM` products
+
+Misc
+----
+- class :class:`pyroSAR.examine.ExamineGamma`: enhanced flexibility in finding GAMMA installation
diff --git a/docs/source/api/examine.rst b/docs/source/api/examine.rst
@@ -0,0 +1,10 @@
+Examine
+=======
+
+.. automodule:: pyroSAR.examine
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+    .. autosummary::
+        :nosignatures:
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -29,6 +29,7 @@ API Documentation
     api/auxdata
     api/datacube
     api/ancillary
+    api/examine
 
 About
 =====

diff --git a/pyroSAR/examine.py b/pyroSAR/examine.py
@@ -370,6 +370,17 @@ def get_version(self, module):
 
 
 class ExamineGamma(object):
+    """
+    Class to check if GAMMA is installed.
+    
+    Examples
+    --------
+    >>> from pyroSAR.examine import ExamineGamma
+    >>> config = ExamineGamma()
+    >>> print(config.home)
+    >>> print(config.version)
+    
+    """
     def __init__(self):
         home_sys = os.environ.get('GAMMA_HOME')
         if home_sys is not None and not os.path.isdir(home_sys):