jerlov 0.2.1__tar.gz → 0.2.2__tar.gz

{jerlov-0.2.1/jerlov.egg-info → jerlov-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jerlov
-Version: 0.2.1
+Version: 0.2.2
 Summary: Inherent optical properties of Jerlov water types, with provenance
 Author: T. Ishibashi
 License-Expression: Apache-2.0
@@ -257,16 +257,17 @@ rather than substituting a neighbour.
 ## Examples
 
 ```
-python examples/sources_disagree.py
-python examples/synthetic_underwater_images.py
+python examples/sources_disagree.py            why the source is an argument
+python examples/from_one_measurement.py        from an instrument reading
+python examples/synthetic_underwater_images.py appearance at range and depth
+python examples/solar_heating.py               for ocean circulation models
+python examples/what_an_eye_sees.py            any spectral sensitivity
 ```
 
-The first shows why the source is an argument: at 510 nm the scattering
-coefficient of Jerlov III differs by a factor of 3.8 between the two published
-sets. The second synthesises how reflectance patches appear at range and
-depth, white-balanced two ways, and ends with a list of everything it assumed.
-
-Both are run by CI, so an example that has stopped working is a failed build.
+Five scripts, each aimed at a different reader; `examples/README.md` says
+which to start with. CI runs all of them on every push, so an example that has
+stopped working is a failed build. Every one ends with the assumptions it
+made.
 
 ## Provenance and design
 

{jerlov-0.2.1 → jerlov-0.2.2}/README.md

@@ -232,16 +232,17 @@ rather than substituting a neighbour.
 ## Examples
 
 ```
-python examples/sources_disagree.py
-python examples/synthetic_underwater_images.py
+python examples/sources_disagree.py            why the source is an argument
+python examples/from_one_measurement.py        from an instrument reading
+python examples/synthetic_underwater_images.py appearance at range and depth
+python examples/solar_heating.py               for ocean circulation models
+python examples/what_an_eye_sees.py            any spectral sensitivity
 ```
 
-The first shows why the source is an argument: at 510 nm the scattering
-coefficient of Jerlov III differs by a factor of 3.8 between the two published
-sets. The second synthesises how reflectance patches appear at range and
-depth, white-balanced two ways, and ends with a list of everything it assumed.
-
-Both are run by CI, so an example that has stopped working is a failed build.
+Five scripts, each aimed at a different reader; `examples/README.md` says
+which to start with. CI runs all of them on every push, so an example that has
+stopped working is a failed build. Every one ends with the assumptions it
+made.
 
 ## Provenance and design
 

{jerlov-0.2.1 → jerlov-0.2.2}/jerlov/__init__.py

@@ -64,4 +64,4 @@ __all__ = [
     "MissingQuantityError",
 ]
 
-__version__ = "0.2.1"
+__version__ = "0.2.2"

{jerlov-0.2.1 → jerlov-0.2.2}/jerlov/colour.py

@@ -151,15 +151,18 @@ def integrate_response(spectrum, wavelengths, response, response_wavelengths,
     if wavelengths.size < 2:
         raise ValueError("at least two wavelengths are needed to integrate")
 
-    worst = min(
-        _coverage(wavelengths, response_wavelengths, response[:, k])
-        for k in range(response.shape[1])
-    )
+    covered = [_coverage(wavelengths, response_wavelengths, response[:, k])
+               for k in range(response.shape[1])]
+    worst = min(covered)
     if worst < 0.999:
+        which = (f"channel {covered.index(worst)} of {len(covered)}"
+                 if len(covered) > 1 else "it")
         warnings.warn(
-            f"the spectrum spans {wavelengths[0]:g}-{wavelengths[-1]:g} nm and "
-            f"covers only {worst:.1%} of the {name}; the integral is over the "
-            "overlap and is biased by what was left out",
+            f"the spectrum spans {wavelengths[0]:g}-{wavelengths[-1]:g} nm; "
+            f"of the {name}, {which} is only {worst:.1%} covered "
+            f"(all channels: {', '.join(f'{c:.1%}' for c in covered)}). "
+            "The integral is over the overlap and is biased by what was left "
+            "out",
             CoverageWarning,
             stacklevel=2,
         )

{jerlov-0.2.1 → jerlov-0.2.2/jerlov.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jerlov
-Version: 0.2.1
+Version: 0.2.2
 Summary: Inherent optical properties of Jerlov water types, with provenance
 Author: T. Ishibashi
 License-Expression: Apache-2.0
@@ -257,16 +257,17 @@ rather than substituting a neighbour.
 ## Examples
 
 ```
-python examples/sources_disagree.py
-python examples/synthetic_underwater_images.py
+python examples/sources_disagree.py            why the source is an argument
+python examples/from_one_measurement.py        from an instrument reading
+python examples/synthetic_underwater_images.py appearance at range and depth
+python examples/solar_heating.py               for ocean circulation models
+python examples/what_an_eye_sees.py            any spectral sensitivity
 ```
 
-The first shows why the source is an argument: at 510 nm the scattering
-coefficient of Jerlov III differs by a factor of 3.8 between the two published
-sets. The second synthesises how reflectance patches appear at range and
-depth, white-balanced two ways, and ends with a list of everything it assumed.
-
-Both are run by CI, so an example that has stopped working is a failed build.
+Five scripts, each aimed at a different reader; `examples/README.md` says
+which to start with. CI runs all of them on every push, so an example that has
+stopped working is a failed build. Every one ends with the assumptions it
+made.
 
 ## Provenance and design
 

{jerlov-0.2.1 → jerlov-0.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "jerlov"
-version = "0.2.1"
+version = "0.2.2"
 description = "Inherent optical properties of Jerlov water types, with provenance"
 readme = "README.md"
 requires-python = ">=3.10"

{jerlov-0.2.1 → jerlov-0.2.2}/tests/test_colour.py

@@ -73,7 +73,7 @@ def test_each_primary_lights_only_its_own_channel():
 def test_a_narrow_spectrum_warns():
     """450-650 nm looks like a full spectrum but is not."""
     wl = np.arange(450.0, 651.0, 1.0)
-    with pytest.warns(CoverageWarning, match="covers only"):
+    with pytest.warns(CoverageWarning, match="covered"):
         spectrum_to_xyz(np.ones_like(wl), wl)
 
 
@@ -88,8 +88,13 @@ def test_the_warning_states_what_was_missed():
     with pytest.warns(CoverageWarning) as caught:
         spectrum_to_xyz(np.ones_like(wl), wl)
     message = str(caught[0].message)
-    assert "500-600 nm" in message
-    assert "CIE 1931" in message
+    assert "500-600 nm" in message          # the span it actually had
+    assert "CIE 1931" in message            # what it was integrated against
+    assert "all channels:" in message       # not just the worst one
+    # z-bar peaks at 445 nm, so 500-600 nm barely touches it. Naming the
+    # channel matters: "4.1% covered" alone reads as if the whole observer
+    # were 4.1% covered, which would be wrong.
+    assert "channel 2 of 3" in message
 
 
 # -- white, the other one ------------------------------------------------

{jerlov-0.2.1 → jerlov-0.2.2}/tests/test_packaging.py

@@ -76,3 +76,67 @@ def test_every_shipped_table_has_a_build_script_or_is_explained():
     scripts = " ".join(p.read_text() for p in (ROOT / "tools").glob("*.py"))
     for csv in sorted((ROOT / "jerlov" / "data").glob("*.csv")):
         assert csv.name in scripts, f"no build script writes {csv.name}"
+
+
+# -- the documentation counts itself -------------------------------------
+
+_SPELLED = ["zero", "one", "two", "three", "four", "five", "six", "seven",
+            "eight", "nine", "ten", "eleven", "twelve", "thirteen", "fourteen",
+            "fifteen", "sixteen", "seventeen", "eighteen", "nineteen",
+            "twenty", "twenty-one", "twenty-two", "twenty-three",
+            "twenty-four", "twenty-five"]
+WORDS = {word: value for value, word in enumerate(_SPELLED)}
+WORDS.update({word.capitalize(): value
+              for value, word in enumerate(_SPELLED)})
+
+
+def _numbered_sections(text: str) -> int:
+    return len(re.findall(r"^## \d+\. ", text, re.MULTILINE))
+
+
+def _confirmed_sections(text: str) -> int:
+    return len(re.findall(r"^## \d+\..*\(confirmed", text, re.MULTILINE))
+
+
+@source_tree
+def test_DATA_md_counts_its_own_sections():
+    """The opening summary is written by hand and has drifted three times."""
+    text = (ROOT / "DATA.md").read_text()
+    match = re.search(r"^(\w+) entries are recorded below\. (\w+) are confirmed",
+                      text, re.MULTILINE)
+    assert match, "DATA.md no longer opens with a countable summary"
+    claimed_total, claimed_confirmed = (WORDS[g] for g in match.groups())
+    assert claimed_total == _numbered_sections(text)
+    assert claimed_confirmed == _confirmed_sections(text)
+
+
+@source_tree
+def test_the_zenodo_record_will_carry_what_it_should():
+    """`.zenodo.json` is only read at archive time, so nothing else checks it."""
+    import json
+
+    record = json.loads((ROOT / ".zenodo.json").read_text())
+    assert record["upload_type"] == "software"
+    assert record["license"] == "Apache-2.0"
+    assert record["creators"], "a record with no author is not citable"
+    for creator in record["creators"]:
+        assert creator.get("orcid"), (
+            f"{creator['name']} has no ORCID, so the record will not attach "
+            "to their publication list"
+        )
+    # Every source the package ships data from should be reachable from the
+    # record, not only from DATA.md.
+    derived = [r["identifier"] for r in record["related_identifiers"]
+               if r["relation"] == "isDerivedFrom"]
+    assert len(derived) >= 8, derived
+
+
+@source_tree
+def test_the_README_agrees_with_DATA_md_on_the_count():
+    data = (ROOT / "DATA.md").read_text()
+    readme = (ROOT / "README.md").read_text()
+    match = re.search(r"(\w+) entries are\s+documented there: (\w+) confirmed",
+                      readme)
+    assert match, "the README no longer states the count"
+    assert WORDS[match.group(1)] == _numbered_sections(data)
+    assert WORDS[match.group(2)] == _confirmed_sections(data)