gwexpy 0.1.1__py3-none-any.whl

gwexpy/__init__.py

@@ -0,0 +1,224 @@
+"""gwexpy: GWpy Expansions for Experiments.
+
+This package extends GWpy with additional functionality for
+gravitational wave and time-series data analysis.
+"""
+from __future__ import annotations
+
+import warnings
+from typing import TYPE_CHECKING, Any
+
+from astropy.utils.exceptions import AstropyWarning
+
+from . import _warnings  # noqa: F401 – registers package-level warning filters
+
+# Keep docs/tutorial output readable by suppressing known noisy warnings.
+# This must run before importing GWpy/LAL (which can emit warnings at import time).
+warnings.filterwarnings("ignore", "Wswiglal-redir-stdio")
+
+# -----------------------------------------------------------------------------
+# Compatibility: some minimal or newer gwpy builds used in docs/CI may lack
+# `gwpy.io.registry.register_reader` / `register_identifier` / `register_writer`.
+# Ensure the attributes exist so our IO modules' registration calls don't
+# explode during import in stripped-down environments.
+# -----------------------------------------------------------------------------
+try:  # pragma: no cover - defensive
+    import gwpy.io as _gwpy_io
+
+    _io_reg = getattr(_gwpy_io, "registry", None)
+    if _io_reg is not None:
+
+        def _noop(*_args, **_kwargs):
+            return None
+
+        for _name in ("register_reader", "register_identifier", "register_writer"):
+            if not hasattr(_io_reg, _name):
+                setattr(_io_reg, _name, _noop)  # type: ignore[attr-defined]
+except (ImportError, AttributeError):
+    pass
+
+warnings.filterwarnings(
+    "ignore",
+    message=r"xindex was given to .*\(\), x0 will be ignored",
+    category=UserWarning,
+    module="gwpy",
+)
+warnings.filterwarnings(
+    "ignore",
+    message=r"xindex was given to .*\(\), dx will be ignored",
+    category=UserWarning,
+    module="gwpy",
+)
+warnings.filterwarnings(
+    "ignore",
+    message=r"yindex was given to .*\(\), dy will be ignored",
+    category=UserWarning,
+    module="gwpy",
+)
+warnings.filterwarnings("ignore", category=AstropyWarning)
+warnings.filterwarnings("ignore", category=FutureWarning, module="sklearn")
+warnings.filterwarnings("ignore", category=FutureWarning, module="control")
+warnings.filterwarnings(
+    "ignore", message="Protobuf gencode version", category=UserWarning
+)
+warnings.filterwarnings(
+    "ignore",
+    message=r"pkg_resources is deprecated as an API\..*",
+    category=UserWarning,
+)
+warnings.filterwarnings(
+    "ignore",
+    message=r".*joblib will operate in serial mode.*",
+    category=UserWarning,
+)
+
+# Subpackages are available via namespace
+from . import (
+    astro,
+    detector,
+    frequencyseries,
+    histogram,
+    interop,
+    io,
+    noise,
+    plot,
+    segments,
+    signal,
+    spectral,
+    spectrogram,
+    table,
+    time,
+    timeseries,
+    types,
+)
+from ._bootstrap import register_all
+from ._version import __version__
+from .fields import FieldDict, FieldList, ScalarField, TensorField, VectorField
+from .frequencyseries import (
+    FrequencySeries,
+    FrequencySeriesDict,
+    FrequencySeriesList,
+    FrequencySeriesMatrix,
+)
+
+# Histogram types
+from .histogram import (
+    Histogram,
+    HistogramDict,
+    HistogramList,
+)
+
+# Signal processing utilities
+from .signal.preprocessing import (
+    StandardizationModel,
+    WhiteningModel,
+    impute,
+    standardize,
+    whiten,
+)
+from .spectrogram import (
+    Spectrogram,
+    SpectrogramDict,
+    SpectrogramList,
+    SpectrogramMatrix,
+)
+
+# Core data types - explicitly imported for IDE support and clear API
+from .timeseries import (
+    TimeSeries,
+    TimeSeriesDict,
+    TimeSeriesList,
+    TimeSeriesMatrix,
+)
+
+# Types
+from .types import (
+    MetaData,
+    MetaDataDict,
+    MetaDataMatrix,
+    SeriesMatrix,
+    as_series,
+)
+
+__all__ = [
+    # Bootstrap
+    "register_all",
+    # Version
+    "__version__",
+    # TimeSeries types
+    "TimeSeries",
+    "TimeSeriesDict",
+    "TimeSeriesList",
+    "TimeSeriesMatrix",
+    # FrequencySeries types
+    "FrequencySeries",
+    "FrequencySeriesDict",
+    "FrequencySeriesList",
+    "FrequencySeriesMatrix",
+    # Spectrogram types
+    "Spectrogram",
+    "SpectrogramList",
+    "SpectrogramDict",
+    "SpectrogramMatrix",
+    # Histogram types
+    "Histogram",
+    "HistogramDict",
+    "HistogramList",
+    # Types
+    "ScalarField",
+    "VectorField",
+    "TensorField",
+    "FieldList",
+    "FieldDict",
+    "SeriesMatrix",
+    "MetaData",
+    "MetaDataDict",
+    "MetaDataMatrix",
+    "as_series",
+    # Signal preprocessing
+    "whiten",
+    "standardize",
+    "impute",
+    "WhiteningModel",
+    "StandardizationModel",
+    # Subpackages
+    "timeseries",
+    "frequencyseries",
+    "histogram",
+    "spectrogram",
+    "spectral",
+    "astro",
+    "detector",
+    "plot",
+    "segments",
+    "signal",
+    "table",
+    "time",
+    "types",
+    "io",
+    "interop",
+    "noise",
+    "fitting",
+]
+
+if TYPE_CHECKING:  # pragma: no cover
+    import gwexpy.fitting as fitting
+
+
+def __getattr__(name: str) -> Any:
+    if name == "fitting":
+        import importlib
+
+        mod = importlib.import_module(".fitting", __name__)
+        globals()["fitting"] = mod
+        return mod
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+
+def __dir__() -> list[str]:
+    return sorted(set(__all__) | set(globals().keys()))
+
+
+# Mark bootstrap as complete — all subpackages have been imported above,
+# so the registry is fully populated.
+register_all()

gwexpy/_bootstrap.py

@@ -0,0 +1,59 @@
+"""Explicit bootstrap for gwexpy registry initialization.
+
+Normally, ``import gwexpy`` eagerly imports all subpackages, which triggers
+constructor and I/O format registration as a side effect.  However, if a
+user or tool imports a submodule directly (e.g.,
+``from gwexpy.interop._registry import ConverterRegistry``), registrations
+from other subpackages will not have run yet.
+
+``register_all()`` forces all subpackage imports so the registry is fully
+populated regardless of import order.
+
+Examples
+--------
+>>> from gwexpy import register_all
+>>> register_all()
+
+>>> # Or equivalently, just import the top-level package:
+>>> import gwexpy  # register_all() is called automatically
+
+"""
+from __future__ import annotations
+
+_bootstrapped = False
+
+
+def register_all(*, include_io: bool = True) -> None:
+    """Ensure all constructors and (optionally) I/O formats are registered.
+
+    This function is idempotent — calling it multiple times is safe and
+    effectively free after the first call.
+
+    Parameters
+    ----------
+    include_io : bool, optional
+        If ``True`` (default), also trigger I/O format registration
+        (readers, writers, identifiers).  Set to ``False`` to register
+        only constructors.
+
+    """
+    global _bootstrapped
+    if _bootstrapped:
+        return
+
+    # Force-import subpackages that register constructors.
+    # Python caches modules, so repeated imports are no-ops.
+    import gwexpy.frequencyseries  # noqa: F811
+    import gwexpy.histogram  # noqa: F811
+    import gwexpy.plot  # noqa: F811
+    import gwexpy.spectrogram  # noqa: F811
+    import gwexpy.timeseries  # noqa: F811
+    import gwexpy.types  # noqa: F811
+
+    if include_io:
+        # frequencyseries/__init__.py does not import .io,
+        # so we must trigger it explicitly here.
+        import gwexpy.frequencyseries.io  # noqa: F401
+        import gwexpy.timeseries.io  # noqa: F401
+
+    _bootstrapped = True

gwexpy/_version.py

@@ -0,0 +1,3 @@
+from __future__ import annotations
+
+__version__ = "0.1.1"

gwexpy/_warnings.py

@@ -0,0 +1,50 @@
+"""gwexpy._warnings - Package-level warning filters.
+
+Suppresses noisy warnings from external libraries (gwpy, LAL, matplotlib)
+that are irrelevant to end-users. Filters are registered once at import time.
+
+Only warnings that carry no actionable information for the user are suppressed
+here. Warnings that indicate potential issues with user data or parameters are
+left in place (with appropriate stacklevel so they point to user code).
+"""
+from __future__ import annotations
+
+import warnings
+
+# ---------------------------------------------------------------------------
+# LAL / gwpy initialisation noise
+# ---------------------------------------------------------------------------
+# Emitted by lal when its stdio redirection is activated. No user action needed.
+warnings.filterwarnings(
+    "ignore",
+    message="Wswiglal-redir-stdio",
+    category=UserWarning,
+)
+
+# ---------------------------------------------------------------------------
+# matplotlib backend warnings
+# ---------------------------------------------------------------------------
+# Fired when show() is called in a non-interactive backend (e.g. Agg in CI).
+warnings.filterwarnings(
+    "ignore",
+    message="FigureCanvasAgg is non-interactive",
+    category=UserWarning,
+)
+
+# ---------------------------------------------------------------------------
+# gwpy / matplotlib axis warnings
+# ---------------------------------------------------------------------------
+# Fired when a log-scaled axis receives a non-positive limit – handled
+# internally by matplotlib and has no effect on the output.
+warnings.filterwarnings(
+    "ignore",
+    message="Attempt to set non-positive",
+    category=UserWarning,
+)
+
+# Fired when a legend is requested but no labelled artists exist. Harmless.
+warnings.filterwarnings(
+    "ignore",
+    message="No artists with labels found",
+    category=UserWarning,
+)

gwexpy/analysis/__init__.py

@@ -0,0 +1,39 @@
+from __future__ import annotations
+
+from .bruco import Bruco, BrucoResult
+from .coupling import CouplingFunctionAnalysis, estimate_coupling
+from .coupling_result import CouplingResult, CouplingResultCollection
+from .response import (
+    ResponseFunctionAnalysis,
+    ResponseFunctionResult,
+    detect_step_segments,
+    estimate_response_function,
+)
+from .stat_info import association_edges, build_graph
+from .stats import SpectralStats
+from .threshold import (
+    PercentileThreshold,
+    RatioThreshold,
+    SigmaThreshold,
+    ThresholdStrategy,
+)
+
+__all__ = [
+    "Bruco",
+    "BrucoResult",
+    "estimate_coupling",
+    "CouplingFunctionAnalysis",
+    "CouplingResult",
+    "CouplingResultCollection",
+    "ResponseFunctionAnalysis",
+    "ResponseFunctionResult",
+    "SpectralStats",
+    "ThresholdStrategy",
+    "RatioThreshold",
+    "SigmaThreshold",
+    "PercentileThreshold",
+    "estimate_response_function",
+    "detect_step_segments",
+    "association_edges",
+    "build_graph",
+]