jerlov 0.5.0__tar.gz → 0.5.2__tar.gz

{jerlov-0.5.0/jerlov.egg-info → jerlov-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jerlov
-Version: 0.5.0
+Version: 0.5.2
 Summary: Inherent optical properties of Jerlov water types, with provenance
 Author: T. Ishibashi
 License-Expression: Apache-2.0
@@ -101,7 +101,7 @@ reconstructed at 650 nm. ...
 |---|---|---|---|
 | `williamson2022` | measurement | IB-5C | 300-800 nm |
 | `solonenko2015` | inversion of Kd | I-9C | 300-700 nm |
-| `jerlov1976` | Kd only | I-9C | 300-715 nm |
+| `jerlov1976` | Kd only | I-9C | 300-715 nm; printed 310-700, and outside that it warns |
 | `jerlov1968` | Kd only, first edition | I-9C | 310-700 nm |
 | `austin1986` | Kd only, replacement values | I-1C | 350-700 nm |
 
@@ -223,7 +223,7 @@ r.chi_p, r.quoted_error_percent  # 1.18, 3.5
 Boss & Pegau (2001). The pure sea water terms are analytic and are checked
 against the definition of bb rather than transcribed; only the particle
 conversion is tabulated. Angles outside 90-170 degrees are refused, and 170
-warns: its quoted spread is **34.8 percent** against 3-6 in the middle.
+warns: its quoted spread is **34.8 percent** against 2.6-6.4 from 90 to 160.
 
 This gives the bb of the water your instrument was in. It still gives no bb
 for a Jerlov water type, because nothing does.

{jerlov-0.5.0 → jerlov-0.5.2}/README.md

@@ -76,7 +76,7 @@ reconstructed at 650 nm. ...
 |---|---|---|---|
 | `williamson2022` | measurement | IB-5C | 300-800 nm |
 | `solonenko2015` | inversion of Kd | I-9C | 300-700 nm |
-| `jerlov1976` | Kd only | I-9C | 300-715 nm |
+| `jerlov1976` | Kd only | I-9C | 300-715 nm; printed 310-700, and outside that it warns |
 | `jerlov1968` | Kd only, first edition | I-9C | 310-700 nm |
 | `austin1986` | Kd only, replacement values | I-1C | 350-700 nm |
 
@@ -198,7 +198,7 @@ r.chi_p, r.quoted_error_percent  # 1.18, 3.5
 Boss & Pegau (2001). The pure sea water terms are analytic and are checked
 against the definition of bb rather than transcribed; only the particle
 conversion is tabulated. Angles outside 90-170 degrees are refused, and 170
-warns: its quoted spread is **34.8 percent** against 3-6 in the middle.
+warns: its quoted spread is **34.8 percent** against 2.6-6.4 from 90 to 160.
 
 This gives the bb of the water your instrument was in. It still gives no bb
 for a Jerlov water type, because nothing does.

{jerlov-0.5.0 → jerlov-0.5.2}/jerlov/__init__.py

@@ -86,4 +86,4 @@ __all__ = [
     "MissingQuantityError",
 ]
 
-__version__ = "0.5.0"
+__version__ = "0.5.2"

{jerlov-0.5.0 → jerlov-0.5.2}/jerlov/_data.py

@@ -56,7 +56,8 @@ def _frozen(array: np.ndarray) -> np.ndarray:
 #: Values whose ``status`` is one of these should not be used without the
 #: caller being told. See DATA.md sections 1-6.
 QUESTIONABLE = frozenset({"suspect", "missing", "extrapolated",
-                          "model_extrapolation", "reconstructed"})
+                          "model_extrapolation", "reconstructed",
+                          "extrapolated_by_dataset"})
 
 
 def _read(name: str) -> list[dict[str, str]]:

{jerlov-0.5.0 → jerlov-0.5.2}/jerlov/backscattering.py

@@ -48,10 +48,12 @@ _ERROR_WARN_PERCENT = 10.0
 class AngleWarning(UserWarning):
     """The conversion is poorly constrained at the requested angle.
 
-    The shape of the volume scattering function varies most steeply near 90
-    and 180 degrees, so a single-angle measurement there pins bb least well.
-    Both Boss & Pegau (2001) and Maffione & Dana (1997) recommend 110 to 160
-    degrees.
+    The shape of the volume scattering function varies most near 90 and 180
+    degrees, so a single-angle measurement there pins bb least well. Maffione
+    & Dana (1997) recommend sensors covering roughly 110 to 160 degrees. Boss
+    & Pegau (2001) recommend measuring near 117 degrees, and otherwise
+    removing the water contribution first, which they support from near 90
+    to 160 degrees.
     """
 
 
@@ -124,15 +126,15 @@ def _chi_table():
 def particulate_chi(angle_deg):
     """``chi_p`` at one angle, interpolated within Boss & Pegau Table 1.
 
-    Refuses outside 90 to 170 degrees, the range their measurements cover.
+    Refuses outside 90 to 170 degrees, the range their Table 1 covers.
     """
     angle = float(angle_deg)
     if not MIN_ANGLE_DEG <= angle <= MAX_ANGLE_DEG:
         raise ValueError(
             f"chi_p is tabulated from {MIN_ANGLE_DEG:g} to {MAX_ANGLE_DEG:g} "
-            f"degrees and {angle:g} is outside that. Boss & Pegau made no "
-            "measurement beyond 170 degrees, and this package does not "
-            "extrapolate."
+            f"degrees and {angle:g} is outside that. Boss & Pegau tabulate no "
+            "angle beyond 170 degrees, although their instrument reached "
+            "177.3, and this package does not extrapolate."
         )
     angles, values, _ = _chi_table()
     return float(np.interp(angle, angles, values))
@@ -197,7 +199,7 @@ def bb_from_vsf(beta, angle_deg: float, wavelength_nm, *,
     if error > _ERROR_WARN_PERCENT:
         warnings.warn(
             f"chi_p at {angle:g} degrees carries a quoted spread of "
-            f"{error:.1f}%, against 3-6% between 100 and 160 degrees. The "
+            f"{error:.1f}%, against 2.6-6.4% from 90 to 160 degrees. The "
             "scattering function varies steeply here and a single-angle "
             "measurement pins bb poorly.",
             AngleWarning,

{jerlov-0.5.0 → jerlov-0.5.2}/jerlov/data/boss2001_chi.csv

@@ -7,7 +7,7 @@ boss2001,130,1.17,chi_p,3.3,ok,
 boss2001,140,1.18,chi_p,3.5,ok,
 boss2001,150,1.13,chi_p,4.2,ok,
 boss2001,160,1.0,chi_p,6.4,ok,
-boss2001,170,0.62,chi_p,34.8,suspect,"the volume scattering function varies most steeply here, and no measurement in the set went beyond 170 deg"
+boss2001,170,0.62,chi_p,34.8,suspect,"the quoted spread is 34.8 percent here, against 2.6 to 6.4 at the other angles; Table 1 stops at this angle, although the instrument measured to 177.3 deg"
 oishi1990,120,1.14,chi,,other_definition,"chi including water, quoted by Maffione & Dana (1997) from Oishi (1990), Appl. Opt. 29, 4658"
 oishi1990,140,1.08,chi,,other_definition,as above
 maffione1997,140,1.08,chi,9.0,other_definition,"chi including water, Maffione & Dana (1997), Appl. Opt. 36, 6057, from Mie computations; the 9 percent is their standard deviation"