forcingkit 0.9.0__tar.gz → 0.10.0__tar.gz

{forcingkit-0.9.0 → forcingkit-0.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: forcingkit
-Version: 0.9.0
+Version: 0.10.0
 Summary: Spatiotemporal forcing for computational Earth-system models: selects, regrids and serves model-ready time series with provenance.
 Project-URL: Documentation, https://forcingkit.docs.lhzn.io
 Project-URL: Issues, https://github.com/lhzn-io/forcingkit/issues

{forcingkit-0.9.0 → forcingkit-0.10.0}/docs/source/conf.py

@@ -9,7 +9,7 @@ sys.path.insert(0, os.path.abspath("../../src"))
 project = "forcingkit"
 copyright = "2026, Long Horizon Observatory"
 author = "Daniel Fry"
-release = "0.9.0"
+release = "0.10.0"
 
 extensions = [
     "sphinx.ext.autodoc",

{forcingkit-0.9.0 → forcingkit-0.10.0}/docs/source/mesh_frames.rst

@@ -45,12 +45,18 @@ Colour
   last row take the last colour; NaN is transparent. ``load_lut_csv(path)`` reads such a table
   from a ``value,r,g,b[,a]`` CSV;
 - ``packaged_color("currents_lis")``: the surface-current table shipped with the package
-  (``forcingkit/ramps/currents_lis.csv``), 0.02 to 3.1 m/s on a log axis, pale blue through
-  yellow to dark green with CIELAB lightness falling monotonically. Its CSV header records the
+  (``forcingkit/ramps/currents_lis.csv``), 0.02 to 3.1 m/s on a log axis, pale aqua through
+  teal to deep blue-green with CIELAB lightness falling monotonically. Its CSV header records the
   knots and their source;
 - ``packaged_color("currents_lis_dark")``: its twin for a dark basemap, on the same speeds, from
-  midnight blue through steel blue to pale seafoam with lightness rising monotonically, so the
-  two swap by theme alone.
+  deep blue-teal through teal to pale seafoam with lightness rising monotonically, so the two
+  swap by theme alone;
+- ``packaged_color("currents_lis_deep")`` and ``packaged_color("currents_lis_haline")``: multi-hue
+  alternatives on the same speeds, after cmocean "deep" (light backgrounds: pale green through
+  teal and navy to deep purple) and "haline" (dark backgrounds: indigo through blue and green to
+  pale yellow). They separate speeds more strongly than the single-hue pair, but they are not
+  mirror images: purple is fast in one and slow in the other. Use them for a field shown alone
+  with its legend, not beside other colour-mapped layers.
 
 Python
 ------
@@ -83,7 +89,7 @@ Command line
      --size 1200x800 --ramp viridis --vmax 1.5 \
      --edges 0,0,0,40 --background 242,243,240 --out frames/
 
-``--ramp`` takes a built-in name, a packaged table (``currents_lis``, ``currents_lis_dark``) or a path to a
+``--ramp`` takes a built-in name, a packaged table (``currents_lis``, ``currents_lis_dark``, ``currents_lis_deep``, ``currents_lis_haline``) or a path to a
 ``value,r,g,b[,a]`` CSV (with ``--log`` and ``--floor``). The output directory receives
 ``frame_0000.png``, ``frame_0001.png``, ... and ``frames.json``, which lists the frame times, the box
 and the size.

{forcingkit-0.9.0 → forcingkit-0.10.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "forcingkit"
-version = "0.9.0"
+version = "0.10.0"
 description = "Spatiotemporal forcing for computational Earth-system models: selects, regrids and serves model-ready time series with provenance."
 readme = "README.md"
 requires-python = ">=3.11"

forcingkit-0.10.0/src/forcingkit/ramps/currents_lis_deep.csv

@@ -0,0 +1,71 @@
+# Currents speed ramp after cmocean "deep" (Thyng et al. 2016; cmocean is MIT licensed):
+# speed_m_s,r,g,b (sRGB), on the same speeds as currents_lis. Interpolate in log(speed); speeds below the
+# first row take its colour (floor 0.02 m/s) and speeds above the last row (3.1 m/s) clamp to it.
+# Multi-hue for light backgrounds, for a field shown alone with its legend (exports, animations): pale
+# green at slack through teal and navy to deep purple, lightness falling with speed. Colormap position
+# is piecewise linear in log(speed): 0.02 -> 0.12 (past deep's pale-yellow start, so slack never reads
+# as sand), 0.494 -> 0.38, 2.418 -> 0.80, 3.097 -> 1.0.
+# Knots from 2026 NOAA CO-OPS current predictions (MAX_SLACK), Long Island Sound and Block Island
+# Sound: regional median daily maximum 0.494 m/s; ACT2611 Little Gull Island median daily maximum
+# 2.418 m/s, 95th percentile 2.964 m/s, annual maximum 3.097 m/s.
+speed_m_s,r,g,b
+0.0200,191,231,174
+0.0221,187,230,172
+0.0244,183,229,171
+0.0270,178,227,170
+0.0299,172,225,168
+0.0330,167,224,167
+0.0365,163,222,166
+0.0403,159,221,165
+0.0446,154,219,165
+0.0493,150,218,164
+0.0545,146,216,164
+0.0602,141,215,163
+0.0666,137,213,163
+0.0736,133,211,163
+0.0813,129,210,163
+0.0899,125,208,163
+0.0994,120,206,163
+0.1099,117,204,163
+0.1215,113,202,163
+0.1343,110,200,163
+0.1484,107,198,163
+0.1641,105,196,164
+0.1813,102,194,164
+0.2005,100,193,164
+0.2216,98,191,164
+0.2449,96,189,164
+0.2708,94,187,164
+0.2993,92,185,164
+0.3309,90,183,164
+0.3657,88,179,164
+0.4043,87,177,164
+0.4469,86,175,164
+0.4940,85,173,163
+0.5348,82,168,163
+0.5790,79,162,162
+0.6269,77,157,161
+0.6787,75,152,160
+0.7348,73,146,159
+0.7955,72,141,157
+0.8613,70,136,156
+0.9324,68,130,155
+1.0095,67,125,154
+1.0929,65,119,153
+1.1833,64,114,152
+1.2810,63,109,151
+1.3869,62,103,149
+1.5015,62,98,148
+1.6256,62,92,147
+1.7600,62,86,145
+1.9054,63,80,142
+2.0629,65,74,137
+2.2334,65,69,131
+2.4180,65,64,123
+2.5198,63,57,108
+2.6259,60,51,95
+2.7365,56,45,81
+2.8518,51,39,68
+2.9719,45,32,55
+3.0970,40,26,44
+3.1000,40,26,44

forcingkit-0.10.0/src/forcingkit/ramps/currents_lis_haline.csv

@@ -0,0 +1,70 @@
+# Currents speed ramp after cmocean "haline" (Thyng et al. 2016; cmocean is MIT licensed):
+# speed_m_s,r,g,b (sRGB), on the same speeds as currents_lis. Interpolate in log(speed); speeds below the
+# first row take its colour (floor 0.02 m/s) and speeds above the last row (3.1 m/s) clamp to it.
+# Multi-hue for dark backgrounds, for a field shown alone with its legend (exports, animations): indigo
+# at slack through blue and green to pale yellow, lightness rising with speed. Colormap position is
+# piecewise linear in log(speed): 0.02 -> 0, 0.494 -> 0.29, 2.418 -> 0.80, 3.097 -> 1.0.
+# Knots from 2026 NOAA CO-OPS current predictions (MAX_SLACK), Long Island Sound and Block Island
+# Sound: regional median daily maximum 0.494 m/s; ACT2611 Little Gull Island median daily maximum
+# 2.418 m/s, 95th percentile 2.964 m/s, annual maximum 3.097 m/s.
+speed_m_s,r,g,b
+0.0200,42,24,108
+0.0221,42,25,113
+0.0244,43,25,117
+0.0270,44,26,122
+0.0299,45,27,130
+0.0330,46,27,135
+0.0365,46,28,140
+0.0403,46,29,147
+0.0446,46,30,152
+0.0493,45,32,156
+0.0545,43,36,160
+0.0602,41,39,162
+0.0666,38,43,163
+0.0736,34,48,163
+0.0813,32,52,162
+0.0899,29,55,161
+0.0994,25,60,159
+0.1099,23,63,158
+0.1215,21,65,156
+0.1343,18,69,155
+0.1484,16,72,153
+0.1641,15,74,152
+0.1813,13,78,150
+0.2005,12,80,149
+0.2216,12,82,148
+0.2449,12,84,147
+0.2708,13,87,146
+0.2993,14,89,145
+0.3309,15,91,144
+0.3657,17,94,143
+0.4043,19,96,142
+0.4469,20,98,142
+0.4940,23,100,141
+0.5348,28,106,140
+0.5790,34,112,138
+0.6269,38,117,138
+0.6787,43,123,137
+0.7348,47,128,137
+0.7955,52,134,136
+0.8613,55,139,136
+0.9324,59,145,135
+1.0095,62,151,135
+1.0929,66,157,133
+1.1833,70,164,131
+1.2810,74,169,129
+1.3869,79,175,126
+1.5015,84,181,123
+1.6256,92,187,119
+1.7600,99,192,114
+1.9054,110,198,109
+2.0629,120,203,104
+2.2334,134,208,98
+2.4180,148,211,93
+2.5198,170,216,92
+2.6259,189,220,98
+2.7365,208,224,109
+2.8518,224,229,122
+2.9719,240,234,138
+3.0970,253,239,154
+3.1000,253,239,154

{forcingkit-0.9.0 → forcingkit-0.10.0}/src/forcingkit/render.py

@@ -146,6 +146,10 @@ PACKAGED_RAMPS: dict[str, dict] = {
     "currents_lis": {"log": True, "floor": 0.02},
     # Its twin for a dark basemap: the same speeds, lightness rising monotonically.
     "currents_lis_dark": {"log": True, "floor": 0.02},
+    # Multi-hue alternatives on the same speeds, after cmocean "deep" (light backgrounds; lightness
+    # falling) and "haline" (dark; rising), for a field shown alone with its legend.
+    "currents_lis_deep": {"log": True, "floor": 0.02},
+    "currents_lis_haline": {"log": True, "floor": 0.02},
 }
 
 

{forcingkit-0.9.0 → forcingkit-0.10.0}/tests/unit/test_mesh_frames.py

@@ -367,7 +367,29 @@ def test_dark_currents_ramp_matches_axis_and_rises_in_lightness():
     _assert_cool_hues(dark[:, 1:])
 
 
-@pytest.mark.parametrize("name", ["currents_lis", "currents_lis_dark"])
+@pytest.mark.parametrize(
+    ("name", "falling"), [("currents_lis_deep", True), ("currents_lis_haline", False)]
+)
+def test_multi_hue_currents_ramps_share_the_axis(name, falling):
+    light = np.array(render.packaged_ramp_rows("currents_lis"))
+    rows = np.array(render.packaged_ramp_rows(name))
+    np.testing.assert_array_equal(rows[:, 0], light[:, 0])
+    L = _lightness(rows[:, 1:])
+    steps = np.diff(L)
+    assert np.all(steps <= 0) if falling else np.all(steps >= 0), (
+        "lightness must be monotone"
+    )
+    # No warning hues: nothing between red and orange-yellow among the coloured rows.
+    lab = _lab(rows[:, 1:])
+    hue = np.degrees(np.arctan2(lab[:, 2], lab[:, 1])) % 360
+    chroma = np.hypot(lab[:, 1], lab[:, 2])
+    assert not np.any((chroma > 10) & ((hue < 80) | (hue > 340))), hue
+
+
+@pytest.mark.parametrize(
+    "name",
+    ["currents_lis", "currents_lis_dark", "currents_lis_deep", "currents_lis_haline"],
+)
 def test_currents_ramp_floor_log_axis_and_clamp(name):
     rows = render.packaged_ramp_rows(name)
     color = render.packaged_color(name)

{forcingkit-0.9.0 → forcingkit-0.10.0}/uv.lock

@@ -873,7 +873,7 @@ wheels = [
 
 [[package]]
 name = "forcingkit"
-version = "0.9.0"
+version = "0.10.0"
 source = { editable = "." }
 dependencies = [
     { name = "bottleneck" },