lofar-clocktec 1.0__py3-none-any.whl

lofar_clocktec/__init__.py

@@ -0,0 +1,61 @@
+#  Copyright (C) 2024 ASTRON (Netherlands Institute for Radio Astronomy)
+#  SPDX-License-Identifier: Apache-2.0
+r"""lofar-clocktec: clock/TEC separation from LOFAR calibration phases.
+
+Quick start
+-----------
+
+.. doctest::
+
+    >>> from lofar_clocktec import fit_clock_tec, CTInput, CTOutput
+    >>> import astropy.units as u
+    >>> ct_input = CTInput(  # doctest: +SKIP
+    ...     phases=phases * u.rad,  # shape (n_times, n_freqs, n_stations)
+    ...     freqs=freqs * u.Hz,
+    ...     flags=flags,
+    ...     stations=["CS002HBA", "CS004HBA"],
+    ...     times=times,
+    ... )
+    >>> result = fit_clock_tec(ct_input, ref_station=0, spatial_fit=True)  # doctest: +SKIP
+    >>> result.clock  # nanoseconds, shape (n_stations, n_times) # doctest: +SKIP
+    >>> result.tec  # TECU,        shape (n_stations, n_times) # doctest: +SKIP
+    >>> result.phase0  # radians,     shape (n_stations, n_times) # doctest: +SKIP
+
+Public API
+----------
+:func:`fit_clock_tec`
+    Main entry point. Takes a :class:`CTInput` and returns a :class:`CTOutput`.
+
+:class:`CTInput`
+    NamedTuple holding the input phases, frequencies, flags, station names,
+    and timestamps required for fitting.
+
+:class:`CTOutput`
+    NamedTuple holding the fitted clock delays, TEC values, phase offsets,
+    a validity mask, and the timestamps.
+"""
+
+from __future__ import annotations
+
+from importlib import metadata
+
+from lofar_clocktec.fit_clock_tec import (
+    IDX_CLOCK,
+    IDX_PH0,
+    IDX_TEC,
+    IDX_TEC3,
+    fit_clock_tec,
+)
+from lofar_clocktec.io import CTInput, CTOutput
+
+__version__ = metadata.version("lofar-clocktec")
+
+__all__ = [
+    "IDX_CLOCK",
+    "IDX_PH0",
+    "IDX_TEC",
+    "IDX_TEC3",
+    "CTInput",
+    "CTOutput",
+    "fit_clock_tec",
+]

lofar_clocktec/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '1.0'
+__version_tuple__ = version_tuple = (1, 0)
+
+__commit_id__ = commit_id = None