yippy 2.7.2__tar.gz → 2.7.3__tar.gz

{yippy-2.7.2 → yippy-2.7.3}/.pre-commit-config.yaml

@@ -7,7 +7,7 @@ repos:
         args: [--pytest-test-first]
       - id: end-of-file-fixer
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.15.12
+    rev: v0.15.13
     hooks:
       - id: ruff-check
         args: [--fix]

{yippy-2.7.2 → yippy-2.7.3}/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [2.7.3](https://github.com/CoreySpohn/yippy/compare/v2.7.2...v2.7.3) (2026-05-18)
+
+
+### Bug Fixes
+
+* Move YIP hosting from Zenodo to a data release ([d811a5e](https://github.com/CoreySpohn/yippy/commit/d811a5ef6381ed9c2bfdd0585c24cae1f8e7a23e))
+
 ## [2.7.2](https://github.com/CoreySpohn/yippy/compare/v2.7.1...v2.7.2) (2026-05-15)
 
 

{yippy-2.7.2 → yippy-2.7.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yippy
-Version: 2.7.2
+Version: 2.7.3
 Summary: A Python and JAX wrapper to create a coronagraph object from a yield input package
 Project-URL: Homepage, https://github.com/CoreySpohn/yippy
 Project-URL: Issues, https://github.com/CoreySpohn/yippy/issues
@@ -208,11 +208,11 @@ throughput and core area are computed using an adaptive aperture that includes
 all oversampled pixels exceeding `ratio * peak`. This matches AYO's
 `photap_frac` / `omega_lod` calculation and is recommended for ETC integration.
 
-## Example data (beta)
+## Example data
 
-For convenience, yippy can download a small catalog of example YIPs hosted
-on Zenodo. This is useful for tutorials, CI, and "I just want to try it"
-exploration:
+Two reference YIPs ship as GitHub release assets on this repo and can be
+fetched on demand. This is useful for tutorials, CI, and "I just want to
+try it" exploration:
 
 ```python
 from yippy import Coronagraph, fetch_yip
@@ -221,10 +221,11 @@ yip_path = fetch_yip("eac1_aavc_2d")   # download (cached after first call)
 coro     = Coronagraph(yip_path)
 ```
 
-> **Beta.** The Zenodo-hosted YIP archive is a stopgap. A non-Zenodo
-> distribution channel may replace it in the near future. For production
-> or reproducible work, manage your own YIP paths and pass them to
-> `Coronagraph(path)` directly.
+The catalog is currently minimal. Long-term YIP hosting will be provided by
+ExEP, and only the two reference YIPs used by the yippy paper validation
+pipeline and pyEDITH (`eac1_aavc_2d` and `eac1_optimal_order_6_1d`) are shipped here. For
+production work or YIPs outside this set, manage your own YIP paths and pass
+them to `Coronagraph(path)` directly.
 
 See [`yippy.list_yips()`](https://yippy.readthedocs.io/en/latest/datasets.html)
 for the available names and the

{yippy-2.7.2 → yippy-2.7.3}/README.md

@@ -150,11 +150,11 @@ throughput and core area are computed using an adaptive aperture that includes
 all oversampled pixels exceeding `ratio * peak`. This matches AYO's
 `photap_frac` / `omega_lod` calculation and is recommended for ETC integration.
 
-## Example data (beta)
+## Example data
 
-For convenience, yippy can download a small catalog of example YIPs hosted
-on Zenodo. This is useful for tutorials, CI, and "I just want to try it"
-exploration:
+Two reference YIPs ship as GitHub release assets on this repo and can be
+fetched on demand. This is useful for tutorials, CI, and "I just want to
+try it" exploration:
 
 ```python
 from yippy import Coronagraph, fetch_yip
@@ -163,10 +163,11 @@ yip_path = fetch_yip("eac1_aavc_2d")   # download (cached after first call)
 coro     = Coronagraph(yip_path)
 ```
 
-> **Beta.** The Zenodo-hosted YIP archive is a stopgap. A non-Zenodo
-> distribution channel may replace it in the near future. For production
-> or reproducible work, manage your own YIP paths and pass them to
-> `Coronagraph(path)` directly.
+The catalog is currently minimal. Long-term YIP hosting will be provided by
+ExEP, and only the two reference YIPs used by the yippy paper validation
+pipeline and pyEDITH (`eac1_aavc_2d` and `eac1_optimal_order_6_1d`) are shipped here. For
+production work or YIPs outside this set, manage your own YIP paths and pass
+them to `Coronagraph(path)` directly.
 
 See [`yippy.list_yips()`](https://yippy.readthedocs.io/en/latest/datasets.html)
 for the available names and the

{yippy-2.7.2 → yippy-2.7.3}/docs/datasets.md

@@ -12,21 +12,24 @@ coro = Coronagraph("path/to/eac1_aavc_2d")
 
 For convenience, yippy also ships a small curated catalog of YIPs that
 can be downloaded on demand via [pooch](https://www.fatiando.org/pooch/).
-The catalog is currently hosted on Zenodo and cached locally on first
-use.
+The catalog is hosted as assets on a tagged GitHub release of the yippy
+repository and cached locally on first use.
 
 ```{note}
-The Zenodo-hosted catalog is **beta**. A non-Zenodo distribution channel
-may replace it in the near future. For reproducible or production work,
-manage your own YIP paths and pass them to `Coronagraph(path)` directly.
+The catalog is intentionally minimal. Long-term YIP hosting is ExEP's
+responsibility, and only the two reference YIPs used by the yippy paper
+validation pipeline are shipped here. For production work or YIPs
+outside this set, manage your own YIP paths and pass them to
+`Coronagraph(path)` directly.
 ```
 
 ## Available datasets
 
 The table below is generated from `yippy.datasets.CATALOG` at doc-build
 time and lists every YIP yippy knows about. Every entry in the catalog
-is fetchable; new YIPs are added only once their archive is on Zenodo
-and the md5 hash is locked into the catalog.
+is fetchable; new YIPs are added only when the underlying release is
+bumped (see `DATA_RELEASE_TAG` in `yippy.datasets`) and the md5 hash is
+locked into the catalog.
 
 ```{include} _generated/yip_catalog.md
 ```
@@ -155,17 +158,11 @@ Three small helpers let you browse the catalog without downloading anything.
 ```python
 >>> from yippy import list_yips
 >>> list_yips(telescope="eac1")
-['eac1_aavc_1d',
- 'eac1_spc_1d',
- 'eac1_lcppc_v1_1d',
- 'eac1_optimal_order_6_1d',
- 'eac1_pic_400channels_order6_1d',
- 'eac1_aavc_2d']
+['eac1_aavc_2d',
+ 'eac1_optimal_order_6_1d']
 
 >>> list_yips(coronagraph="optimal_order_6")
-['eac1_optimal_order_6_1d',
- 'eac2_optimal_order_6_1d',
- 'eac3_optimal_order_6_1d']
+['eac1_optimal_order_6_1d']
 
 >>> list_yips(sampling="2d")
 ['eac1_aavc_2d']

{yippy-2.7.2 → yippy-2.7.3}/src/yippy/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '2.7.2'
-__version_tuple__ = version_tuple = (2, 7, 2)
+__version__ = version = '2.7.3'
+__version_tuple__ = version_tuple = (2, 7, 3)
 
 __commit_id__ = commit_id = None

{yippy-2.7.2 → yippy-2.7.3}/src/yippy/datasets.py

@@ -6,10 +6,17 @@ and filtered discovery (``telescope``, ``coronagraph``, ``sampling``,
 ``md5``). Descriptive metadata (designer, wavelengths, dark-zone
 extent, ...) lives in the FITS headers inside each YIP, not here.
 
-Archives are hosted on Zenodo and fetched via pooch's DOI protocol. To
-publish new YIPs: upload a new Zenodo record version, paste the new DOI
-into ``ZENODO_DOI``, and refresh the md5 hashes via
-``scripts/build_zenodo_archives.py``.
+Archives are hosted as assets on a tagged GitHub release of this repo
+(currently ``data-v1``) and fetched via pooch over HTTPS. The release
+tag is separate from the code-release lifecycle managed by
+release-please. To publish new YIPs: bump ``DATA_RELEASE_TAG`` to a new
+``data-vN``, attach the updated zips to that release, and refresh the
+md5 hashes here.
+
+The two-YIP catalog is intentionally minimal: long-term YIP hosting will
+be provided by ExEP, and yippy hosts only the two reference YIPs used
+by the yippy paper validation pipeline. When ExEP's catalog comes
+online, the discovery API here grows back into a thin proxy over it.
 
 Public API:
 - ``fetch_yip(name=None, *, telescope=None, coronagraph=None, sampling=None,
@@ -47,34 +54,28 @@ logging.getLogger("pooch").setLevel(logging.WARNING)
 CACHE_DIR_ENV_VAR = "YIPPY_CACHE_DIR"
 
 # ---------------------------------------------------------------------------
-# Zenodo DOI for the YIP archive. Updated when a new version of the record
-# is published on Zenodo.
+# Release tag carrying the YIP zip assets on this repo's GitHub releases.
+# Bump to ``data-vN`` when the underlying YIP files change.
 # ---------------------------------------------------------------------------
-ZENODO_DOI: str = "10.5281/zenodo.20146086"
+DATA_RELEASE_TAG: str = "data-v1"
+_DATA_BASE_URL: str = (
+    f"https://github.com/CoreySpohn/yippy/releases/download/{DATA_RELEASE_TAG}/"
+)
 
 
 # ---------------------------------------------------------------------------
 # Catalog
+#
+# Intentionally minimal: long-term YIP hosting is ExEP's responsibility.
+# Only the two reference YIPs used by the yippy paper validation pipeline
+# live here.
 # ---------------------------------------------------------------------------
 CATALOG: dict[str, dict[str, Any]] = {
-    # EAC1 (1D)
-    "eac1_aavc_1d": {
+    "eac1_aavc_2d": {
         "telescope": "eac1",
         "coronagraph": "aavc",
         "designer": "Susan Redmond",
-        "md5": "md5:5cb5fe8bd29c8f4d2abf47b259535061",
-    },
-    "eac1_spc_1d": {
-        "telescope": "eac1",
-        "coronagraph": "spc",
-        "designer": "Jessica Gersh-Range",
-        "md5": "md5:1b70ddebb8b89226b206c6d08817542d",
-    },
-    "eac1_lcppc_v1_1d": {
-        "telescope": "eac1",
-        "coronagraph": "lcppc_v1",
-        "designer": "David Doelman",
-        "md5": "md5:189101a21fdffe7e2a013712f34da83b",
+        "md5": "md5:1f4892faff18e55cbec9781a055bea4d",
     },
     "eac1_optimal_order_6_1d": {
         "telescope": "eac1",
@@ -82,63 +83,6 @@ CATALOG: dict[str, dict[str, Any]] = {
         "designer": "Rus Belikov",
         "md5": "md5:df52540008a0e85467720ec91c3a84b8",
     },
-    "eac1_pic_400channels_order6_1d": {
-        "telescope": "eac1",
-        "coronagraph": "pic_400channels_order6",
-        "designer": "Dan Sirbu",
-        "md5": "md5:b90c4600fc32edfc6007c7fff2642036",
-    },
-    # EAC2 (1D)
-    "eac2_lcppc_v1_1d": {
-        "telescope": "eac2",
-        "coronagraph": "lcppc_v1",
-        "designer": "David Doelman",
-        "md5": "md5:80cfbad3f63eb7c49b467342d19e32cc",
-    },
-    "eac2_optimal_order_6_1d": {
-        "telescope": "eac2",
-        "coronagraph": "optimal_order_6",
-        "designer": "Rus Belikov",
-        "md5": "md5:579c80c9e3f7f52a0ebd18858485fa4b",
-    },
-    "eac2_pic_400channels_order6_1d": {
-        "telescope": "eac2",
-        "coronagraph": "pic_400channels_order6",
-        "designer": "Dan Sirbu",
-        "md5": "md5:384c79d3ac1777c0c2680348cb84fcce",
-    },
-    # EAC3 (1D)
-    "eac3_lcppc_v1_1d": {
-        "telescope": "eac3",
-        "coronagraph": "lcppc_v1",
-        "designer": "David Doelman",
-        "md5": "md5:dd97beca90e8a1f47c0efe8490d40f27",
-    },
-    "eac3_optimal_order_6_1d": {
-        "telescope": "eac3",
-        "coronagraph": "optimal_order_6",
-        "designer": "Rus Belikov",
-        "md5": "md5:7c7a76d324f5b62ba2f0523534dd8076",
-    },
-    "eac3_aplc_1d": {
-        "telescope": "eac3",
-        "coronagraph": "aplc",
-        "designer": "Bryony Nickson",
-        "md5": "md5:2c880190f36d92d7d4c5785a9ebf994a",
-    },
-    "eac3_pic_400channels_order6_1d": {
-        "telescope": "eac3",
-        "coronagraph": "pic_400channels_order6",
-        "designer": "Dan Sirbu",
-        "md5": "md5:5b530b87c2ee6020118455789ac4328e",
-    },
-    # EAC1 (2D)
-    "eac1_aavc_2d": {
-        "telescope": "eac1",
-        "coronagraph": "aavc",
-        "designer": "Susan Redmond",
-        "md5": "md5:1f4892faff18e55cbec9781a055bea4d",
-    },
 }
 
 
@@ -159,7 +103,7 @@ def _make_pikachu(cache_dir_path: str | Path) -> pooch.Pooch:
     """Build a pooch instance for the YIP catalog at ``cache_dir_path``."""
     return pooch.create(
         path=cache_dir_path,
-        base_url=f"doi:{ZENODO_DOI}/",
+        base_url=_DATA_BASE_URL,
         registry={f"{name}.zip": meta["md5"] for name, meta in CATALOG.items()},
     )
 

{yippy-2.7.2 → yippy-2.7.3}/tests/conftest.py

@@ -3,11 +3,11 @@
 import pytest
 
 from yippy import Coronagraph
-from yippy.datasets import CATALOG, ZENODO_DOI
+from yippy.datasets import CATALOG, DATA_RELEASE_TAG
 
 requires_available_yip = pytest.mark.skipif(
-    CATALOG["eac1_aavc_2d"]["md5"] is None or ZENODO_DOI.endswith("PLACEHOLDER"),
-    reason="YIP not yet fetchable: md5 unset or Zenodo DOI is placeholder.",
+    CATALOG["eac1_aavc_2d"]["md5"] is None or DATA_RELEASE_TAG.endswith("PLACEHOLDER"),
+    reason="YIP not yet fetchable: md5 unset or release tag is placeholder.",
 )
 
 

{yippy-2.7.2 → yippy-2.7.3}/tests/test_build_zenodo_archives.py

@@ -132,18 +132,18 @@ def test_build_archive_is_deterministic(tmp_path):
 def test_emit_catalog_block_is_valid_python(tmp_path):
     """The printed CATALOG block must be re-parseable as a Python dict."""
     updates = {
-        "eac1_aavc_1d": "md5:" + "a" * 32,
-        "eac1_spc_1d": None,  # awaiting fresh build
+        "eac1_aavc_2d": "md5:" + "a" * 32,
+        "eac1_optimal_order_6_1d": None,  # awaiting fresh build
     }
     block = bza.format_catalog_block(updates)
     # Confirm Python can evaluate it
     ns: dict = {}
     exec(block, ns)
     parsed = ns["CATALOG"]
-    assert parsed["eac1_aavc_1d"]["md5"] == "md5:" + "a" * 32
-    assert parsed["eac1_aavc_1d"]["designer"] == "Susan Redmond"
-    assert parsed["eac1_spc_1d"]["md5"] is None
-    assert parsed["eac1_spc_1d"]["designer"] == "Jessica Gersh-Range"
-    # Must include all 13 catalog entries (12 1D + 1 2D) even when only
-    # some are updated.
-    assert len(parsed) == 13
+    assert parsed["eac1_aavc_2d"]["md5"] == "md5:" + "a" * 32
+    assert parsed["eac1_aavc_2d"]["designer"] == "Susan Redmond"
+    assert parsed["eac1_optimal_order_6_1d"]["md5"] is None
+    assert parsed["eac1_optimal_order_6_1d"]["designer"] == "Rus Belikov"
+    # The trimmed minimal catalog ships exactly the two reference YIPs
+    # even when only some are updated.
+    assert len(parsed) == 2

{yippy-2.7.2 → yippy-2.7.3}/tests/test_datasets.py

@@ -15,9 +15,15 @@ VALID_HASH = re.compile(r"^md5:[0-9a-f]{32}$")
 VALID_SAMPLING_SUFFIXES = ("_1d", "_2d")
 
 
-def test_catalog_has_13_entries():
-    """Catalog must contain exactly 13 entries (12 1D + 1 2D)."""
-    assert len(datasets.CATALOG) == 13
+def test_catalog_has_two_reference_entries():
+    """Catalog ships the two reference YIPs used by the yippy paper.
+
+    Long-term YIP hosting is ExEP's responsibility; yippy hosts only the
+    minimum needed to reproduce the validation figures. If the catalog
+    grows beyond two reference YIPs, that decision should be reflected
+    by updating this expectation deliberately.
+    """
+    assert set(datasets.CATALOG) == {"eac1_aavc_2d", "eac1_optimal_order_6_1d"}
 
 
 def test_catalog_keys_match_telescope_coronagraph_sampling():
@@ -62,26 +68,21 @@ def test_list_yips_no_filter_returns_all():
 def test_list_yips_telescope_filter():
     """Filtering by telescope returns only matching entries."""
     names = datasets.list_yips(telescope="eac1")
-    assert len(names) == 6  # 5 1D + 1 2D for eac1
-    assert all(n.startswith("eac1_") for n in names)
+    assert sorted(names) == ["eac1_aavc_2d", "eac1_optimal_order_6_1d"]
 
 
 def test_list_yips_coronagraph_filter():
-    """Filtering by coronagraph returns matches across telescopes and samplings."""
-    names = datasets.list_yips(coronagraph="aavc")
-    assert sorted(names) == ["eac1_aavc_1d", "eac1_aavc_2d"]
-
-
-def test_list_yips_combined_filter():
-    """Combining telescope and coronagraph filters narrows when sampling is unique."""
-    names = datasets.list_yips(telescope="eac3", coronagraph="aplc")
-    assert names == ["eac3_aplc_1d"]
+    """Filtering by coronagraph isolates one entry in the minimal catalog."""
+    assert datasets.list_yips(coronagraph="aavc") == ["eac1_aavc_2d"]
+    assert datasets.list_yips(coronagraph="optimal_order_6") == [
+        "eac1_optimal_order_6_1d"
+    ]
 
 
 def test_list_yips_sampling_filter():
     """Filtering by sampling returns all entries of that regime."""
     assert datasets.list_yips(sampling="2d") == ["eac1_aavc_2d"]
-    assert len(datasets.list_yips(sampling="1d")) == 12
+    assert datasets.list_yips(sampling="1d") == ["eac1_optimal_order_6_1d"]
 
 
 def test_list_yips_three_axis_filter_unique():
@@ -89,9 +90,6 @@ def test_list_yips_three_axis_filter_unique():
     assert datasets.list_yips(telescope="eac1", coronagraph="aavc", sampling="2d") == [
         "eac1_aavc_2d"
     ]
-    assert datasets.list_yips(telescope="eac1", coronagraph="aavc", sampling="1d") == [
-        "eac1_aavc_1d"
-    ]
 
 
 def test_list_yips_unknown_kwarg_raises_typeerror():
@@ -117,7 +115,7 @@ def test_yip_exists_unknown_name():
 
 def test_yip_info_returns_metadata_dict():
     """yip_info() returns the catalog metadata dict for a known entry."""
-    info = datasets.yip_info("eac1_aavc_1d")
+    info = datasets.yip_info("eac1_aavc_2d")
     assert info["telescope"] == "eac1"
     assert info["coronagraph"] == "aavc"
     assert "md5" in info
@@ -132,7 +130,7 @@ def test_yip_info_unknown_raises_keyerror():
 def test_fetch_yip_both_name_and_kwargs_raises():
     """Passing both a name and filter kwargs raises TypeError."""
     with pytest.raises(TypeError, match="either"):
-        datasets.fetch_yip("eac1_aavc_1d", telescope="eac1")
+        datasets.fetch_yip("eac1_aavc_2d", telescope="eac1")
 
 
 def test_fetch_yip_neither_name_nor_kwargs_raises():
@@ -156,10 +154,13 @@ def test_fetch_yip_zero_match_query_raises_valueerror():
 
 
 def test_fetch_yip_multi_match_query_raises_valueerror():
-    """A structured query that matches multiple entries raises ValueError."""
-    # eac1 + aavc matches both _1d and _2d; sampling must also be passed.
+    """A structured query that matches multiple entries raises ValueError.
+
+    With the minimal two-YIP catalog, ``telescope='eac1'`` matches both
+    entries because they share that prefix.
+    """
     with pytest.raises(ValueError, match="multiple"):
-        datasets.fetch_yip(telescope="eac1", coronagraph="aavc")
+        datasets.fetch_yip(telescope="eac1")
 
 
 def test_cache_dir_returns_platform_default_when_env_unset(monkeypatch):
@@ -253,8 +254,8 @@ def test_fetch_yip_cache_path_builds_separate_pooch(monkeypatch, tmp_path):
 
 @pytest.mark.network
 @pytest.mark.skipif(
-    datasets.ZENODO_DOI.endswith("PLACEHOLDER"),
-    reason="Zenodo DOI not yet set; v1 release pending.",
+    datasets.DATA_RELEASE_TAG.endswith("PLACEHOLDER"),
+    reason="Release tag not yet set; data-vN release pending.",
 )
 def test_fetch_smallest_yip_loads_as_coronagraph(tmp_path):
     """End-to-end: pull the smallest available YIP and load yippy.Coronagraph."""