Merge pull request #12 from slarosa/doc_rev

merge doc rev branch in dev branch
SatCloP · Jul 27, 2023 · 420e43d · 420e43d
2 parents bf5d791 + 370a4e7
commit 420e43d
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 21 deletions.
diff --git a/docs/source/references.rst b/docs/source/references.rst
@@ -26,6 +26,10 @@ References
 
 .. [Rosenkranz-2017] Rosenkranz, P. W.: Line-by-line microwave radiative transfer (non-scattering), Remote Sens. Code Library, https://doi.org/10.21982/M81013, 2017.
 
+.. [Rosenkranz-2015] Rosenkranz, P. W.: A Model for the Complex Dielectric Constant of Supercooled Liquid Water at Microwave Frequencies, IEEE Transactions on Geoscience and Remote Sensing, vol. 53, no. 3, pp. 1387-1393, March 2015, https://doi.org/10.1109/TGRS.2014.2339015.
+
+.. [Rosenkranz-1988] P.W. Rosenkranz, Interference coefficients for overlapping oxygen lines in air, Journal of Quantitative Spectroscopy and Radiative Transfer, Volume 39, Issue 4, 1988, Pages 287-297, https://doi.org/10.1016/0022-4073(88)90004-0.
+
 .. [Schroeder-Westwater-1991] Schroeder J.A. and E.R. Westwater, Users' Guide to WPL Microwave Radiative Transfer Software, NOAA Technical Memorandum ERL WPL-213, 1991, https://repository.library.noaa.gov/view/noaa/32511
 
 .. [Schroeder-Westwater-1992] Schroeder J.A. and E.R. Westwater, “Guide to Microwave Weighting Function Calculations,” U.S. Dept. ofCommerce, National Oceanic and Atmospheric Administration, Wave Propagation Laboratory, July 1992. 
@@ -36,8 +40,6 @@ References
 
 .. [Liebe-Layton] Liebe, Hans J. and Donald H. Layton. “Millimeter-wave properties of the atmosphere: Laboratory studies and propagation modeling.” (1987).
 
-.. [Rosenkranz-1988] P.W. Rosenkranz, Interference coefficients for overlapping oxygen lines in air, Journal of Quantitative Spectroscopy and Radiative Transfer, Volume 39, Issue 4, 1988, Pages 287-297, https://doi.org/10.1016/0022-4073(88)90004-0.
-
 .. [Liebe-Hufford-Manabe] Liebe H.J., G.A. Hufford and T. Manabe, “A model fo r the complex permittivity of water at frequenciesbelow 1 THz”, Internat. J. Infrared and mm Waves, Vol. 12, pp. 659-675 (1991). 
 
 .. [Liebe-Hufford-Cotton] Liebe, H.J., G.A. Hufford, and M.G. Cotton, Propagation Modeling of Moist Air and SuspendedWater/Ice Particles at Frequencies Below 1000 GH z. AGARD Conference Proc. 542, AtmosphericPropagation Effects through Natural and Man-Made Obscurants for Visible to MM-Wave Radiation,pp.3.1-3.10 (1993). 

diff --git a/pyrtlib/absorption_model.py b/pyrtlib/absorption_model.py
@@ -93,12 +93,12 @@ class LiqAbsModel(AbsModel):
 
     @staticmethod
     def liquid_water_absorption(water: np.ndarray, freq: np.ndarray, temp: np.ndarray) -> np.ndarray:
-        """Computes Absorption In Nepers/Km by Suspended Water Droplets.
+        """Computes absorption in Nepers/km by suspended liquid water droplets.
 
         Args:
-            water (numpy.ndarray): Water in g/m3.
-            freq (numpy.ndarray): Frequency in GHz (Valid From 0 To 1000 Ghz).
-            temp (numpy.ndarray): Temperature in K.
+            water (numpy.ndarray): Liquid water content (g/m3) - (mass of liquid water per volume of dry air).
+            freq (numpy.ndarray): Frequency (GHz) - (valid from 0 to 1000 GHz).
+            temp (numpy.ndarray): Temperature (K).
 
         Returns:
             np.ndarray: [description]
@@ -107,12 +107,14 @@ def liquid_water_absorption(water: np.ndarray, freq: np.ndarray, temp: np.ndarra
         ----------
         .. [1] [Liebe-Hufford-Manabe]_.
         .. [2] [Liebe-Hufford-Cotton]_.
+        .. [3] [Rosenkranz-1988]_.
 
         .. note::
             Revision history:
 
-            * Pwr 8/3/92   Original Version
-            * Pwr 12/14/98 Temp. Dependence Of Eps2 Eliminated To Agree With Mpm93 
+            * PWR 08/03/92 Original Version
+            * PWR 12/14/98 Temp dependence of eps2 eliminated to agree with MPM93 
+            * PWR 06/05/15 Using dilec12 for complex dielectric constant
         """
         if water <= 0:
             abliq = 0
@@ -146,13 +148,13 @@ class N2AbsModel(AbsModel):
 
     @staticmethod
     def n2_absorption(t: np.ndarray, p: np.ndarray, f: np.ndarray) -> np.ndarray:
-        """Collision-Induced Power Absorption Coefficient (Neper/Km) in air
+        """Collision-Induced Power Absorption Coefficient (Neper/km) in air
         with modification of 1.34 to account for O2-O2 and O2-N2 collisions, as calculated by [Boissoles-2003]_.
 
         Args:
             t (numpy.ndarray): Temperature (K).
-            p (numpy.ndarray): Dry Air Pressure (mb).
-            f (numpy.ndarray): Frequency (Ghz)(Valid 0-2000 Ghz).
+            p (numpy.ndarray): Dry air pressure (mb).
+            f (numpy.ndarray): Frequency (GHz) - (valid 0-2000 GHz).
 
         Raises:
             ValueError: _description_
@@ -219,13 +221,13 @@ def h2o_absorption(self, pdrykpa: np.ndarray, vx: np.ndarray, ekpa: np.ndarray,
         """Compute absorption coefficients in atmosphere due to water vapor for all models.
 
         Args:
-            pdrykpa (numpy.ndarray): [description]
-            vx (numpy.ndarray): [description]
-            ekpa (numpy.ndarray): [description]
-            frq (numpy.ndarray): [description]
+            pdrykpa (numpy.ndarray): Dry air pressure (kPa).
+            vx (numpy.ndarray): Theta (adim) - (normalised temperature 300/t(K)).
+            ekpa (numpy.ndarray): Water vapor partial pressure (kPa).
+            frq (numpy.ndarray): Frequency (GHz) - (valid 0-1000 GHz).
 
         Returns:
-            Union[ Tuple[numpy.ndarray, numpy.ndarray], None]: [description]
+            Union[ Tuple[numpy.ndarray, numpy.ndarray], None]: WV line and continuum absirption terms (ppm)
 
         References
         ----------
@@ -541,8 +543,7 @@ def o2_absorption(self, pdrykpa: float, vx: float, ekpa: float, frq: float, amu:
             submm line-widths from Golubiatnikov & Krupnov, except 234-GHz line width from Drouin.
             Mixing coeff. from Makarov's 2018 revision.
          2. The same temperature dependence (X) is used for submillimeter
-            line widths as in the 60 GHz band: (1/T)**X (Koshelev et al 2016)
-         3. The sign of DNU in the shape factor is corrected.
+            line widths as in the 60 GHz band: (1/T)**X (Koshelev et al 2016).
         """
 
         if amu:
@@ -719,12 +720,12 @@ def o3_absorption(self, t: np.ndarray, p: np.ndarray, f: np.ndarray, o3n: np.nda
 
         Args:
             t (np.ndarray): Temperature (K)
-            p (np.ndarray): Total Pressure (mb)
+            p (np.ndarray): Total pressure (mb)
             f (np.ndarray): Frequency (GHz)
-            o3n (np.ndarray): Ozone Number Density (molecules/m^3)
+            o3n (np.ndarray): Ozone number density (molecules/m^3)
 
         Returns:
-            np.ndarray: Ozone Power Absorption Coeff. (Np/km)
+            np.ndarray: Ozone power absorption coeff. (Np/km)
         """
 
         if amu: