feat(solar_activity): Add ICMECAT class for HELIO4CAST ICME catalog access

solarwindpy/solar_activity/__init__.py

@@ -5,13 +5,14 @@
 :mod:`solarwindpy` and exposes convenience utilities for working with them.
 """
 
-__all__ = ["sunspot_number", "ssn", "lisird", "plots"]
+__all__ = ["sunspot_number", "ssn", "lisird", "plots", "icme"]
 
 import pandas as pd
 
 from . import sunspot_number  # noqa: F401
 from . import lisird  # noqa: F401
 from . import plots  # noqa: F401
+from . import icme  # noqa: F401
 
 ssn = sunspot_number
 

solarwindpy/solar_activity/icme/__init__.py

@@ -0,0 +1,34 @@
+"""HELIO4CAST ICMECAT - Interplanetary Coronal Mass Ejection Catalog.
+
+This module provides access to the HELIO4CAST ICMECAT catalog for solar wind
+analysis. See https://helioforecast.space/icmecat for the most up-to-date
+rules of the road.
+
+Rules of the Road (as of January 2026)
+--------------------------------------
+    If this catalog is used for results that are published in peer-reviewed
+    international journals, please contact chris.moestl@outlook.com for
+    possible co-authorship.
+
+    Cite the catalog with: Möstl et al. (2020)
+    DOI: 10.6084/m9.figshare.6356420
+
+Example
+-------
+>>> from solarwindpy.solar_activity.icme import ICMECAT  # doctest: +SKIP
+>>> cat = ICMECAT(spacecraft="Ulysses")  # doctest: +SKIP
+>>> print(f"Found {len(cat)} Ulysses ICMEs")  # doctest: +SKIP
+>>> in_icme = cat.contains(observations.index)  # doctest: +SKIP
+"""
+
+from .icmecat import (
+    ICMECAT,
+    ICMECAT_URL,
+    SPACECRAFT_NAMES,
+)
+
+__all__ = [
+    "ICMECAT",
+    "ICMECAT_URL",
+    "SPACECRAFT_NAMES",
+]