xarray-ms 0.3.8__tar.gz → 0.5.0__tar.gz

{xarray_ms-0.3.8 → xarray_ms-0.5.0}/.github/workflows/ci.yml

@@ -74,7 +74,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Checkout source
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
         with:
           fetch-depth: 1
 
@@ -83,7 +83,7 @@ jobs:
 
       - name: Load cached MSv4 Test Corpus
         id: load-cached-msv4-test-corpus
-        uses: actions/cache@v4
+        uses: actions/cache@v5
         with:
           key: msv4-test-corpus-${{ hashFiles('metadata.json')}}
           path: ~/.cache/xarray-ms/msv4-test-data
@@ -123,7 +123,7 @@ jobs:
           python-version: 3.11
 
       - name: Checkout source
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
         with:
           fetch-depth: 1
 

{xarray_ms-0.3.8 → xarray_ms-0.5.0}/.github/workflows/pre-commit.yml

@@ -6,7 +6,7 @@ jobs:
   pre-commit:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v5
+    - uses: actions/checkout@v6
       with:
         fetch-depth: 1
     - uses: actions/setup-python@v6

{xarray_ms-0.3.8 → xarray_ms-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xarray-ms
-Version: 0.3.8
+Version: 0.5.0
 Summary: xarray MSv4 views over MSv2 Measurement Sets
 Author-email: Simon Perkins <simon.perkins@gmail.com>
 License-File: LICENSE

{xarray_ms-0.3.8 → xarray_ms-0.5.0}/doc/source/changelog.rst

@@ -3,6 +3,20 @@
 Changelog
 =========
 
+0.5.0 (02-03-2026)
+------------------
+* Fix ``VisibilityCoder`` typo (:pr:`145`)
+* Raise an exception if no MSv4 Frame Type is available in ``EpochCoder.decode`` (:pr:`145`)
+* Replace an assert with an ``InvalidMeasurementSet`` exception if the
+  number of ``TabRefTypes`` doesn't match the ``TabRefCodes`` (:pr:`145`)
+* Guard frame inference in a dictionary with a KeyError (:pr:`145`)
+
+0.3.9 (18-02-2026)
+------------------
+* Define and use an ``OnMissingLiteralType`` (:pr:`144`)
+* Correct exception name from ComplexMeasuremetSet to ComplexMeasurementSet (:pr:`143`)
+* Remove poetry-specific installation documentation (:pr:`140`)
+
 0.3.8 (17-10-2025)
 ------------------
 * Synchronise with v4.0.0 schema version (:pr:`139`)

{xarray_ms-0.3.8 → xarray_ms-0.5.0}/doc/source/conf.py

@@ -11,7 +11,7 @@
 project = "xarray-ms"
 copyright = "2024 - 2025 NRF (SARAO) and Rhodes University (RATT) Centre"
 author = "Simon Perkins"
-release = "0.3.8"
+release = "0.5.0"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

{xarray_ms-0.3.8 → xarray_ms-0.5.0}/doc/source/install.rst

@@ -16,40 +16,31 @@ they must be installed separately.
 Development
 ===========
 
-Firstly, install Python `Poetry <poetry_>`_.
-
-.. _poetry: https://python-poetry.org/
-
-Then, the following commands will install the required dependencies,
-optional testing dependencies, documentation and development dependencies
-in a suitable virtual environment:
+Create a virtual environment and install with the dev, doc and testing
+dependencies:
 
 .. code-block:: bash
 
-  $ cd /code/arcae
-  $ poetry env use 3.11
-  $ poetry install -E testing --with doc --with dev
-  $ poetry run pre-commit install
-  $ poetry shell
+
+  $ virtualenv -p python3.12 /tmp/xms
+  $ source xms/bin/activate
+  (xms) $ pip install -e .[dev,doc,testing]
 
 The pre-commit hooks can be manually executed as follows:
 
 .. code-block:: bash
 
-  $ poetry run pre-commit run -a
-
+  (xms) $ pre-commit run -a
 
 Test Suite
 ----------
 
-Run the following command within the arcae source code directory to
-execute the test suite
+After creating the virtual environment above, run the following command
+within the xarray-ms source code directory to execute the test suite:
 
 .. code-block:: bash
 
-  $ cd /code/arcae
-  $ poetry install -E testing --with dev
-  $ poetry run py.test -s -vvv tests/
+  (xms) $ py.test -s -vvv tests/
 
 
 Documentation
@@ -60,15 +51,8 @@ build the Sphinx documentation
 
 .. code-block:: bash
 
-  $ cd /code/arcae
-  $ poetry install --with doc
-  $ poetry shell
-  $ cd doc
-  $ make html
-
-.. _cubed: https://cubed-dev.github.io/cubed/
-.. _dask: https://www.dask.org/
-.. _zarr: https://zarr.dev/
+  (xms) $ cd doc
+  (xms) $ make html
 
 Release Process
 ---------------
@@ -88,3 +72,7 @@ on the ``main`` branch:
    .. code-block:: bash
 
       $ tbump 0.2.0
+
+.. _cubed: https://cubed-dev.github.io/cubed/
+.. _dask: https://www.dask.org/
+.. _zarr: https://zarr.dev/

{xarray_ms-0.3.8 → xarray_ms-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "xarray-ms"
-version = "0.3.8"
+version = "0.5.0"
 description = "xarray MSv4 views over MSv2 Measurement Sets"
 authors = [{name = "Simon Perkins", email = "simon.perkins@gmail.com"}]
 readme = "README.rst"
@@ -54,7 +54,7 @@ extend-select = ["I"]
 # github_url = "https://github.com/<user or organization>/<project>/"
 
 [tool.tbump.version]
-current = "0.3.8"
+current = "0.5.0"
 
 # Example of a semver regexp.
 # Make sure this matches current_version before

{xarray_ms-0.3.8 → xarray_ms-0.5.0}/xarray_ms/backend/msv2/factories/correlated.py

@@ -23,7 +23,7 @@ from xarray_ms.backend.msv2.imputation import (
 from xarray_ms.backend.msv2.measures_encoders import (
   MSv2Coder,
   MSv2CoderFactory,
-  VisiblityCoder,
+  VisibilityCoder,
 )
 from xarray_ms.backend.msv2.structure import MSv2StructureFactory, PartitionKeyT
 from xarray_ms.casa_types import ColumnDesc, Polarisations
@@ -57,7 +57,7 @@ MSV4_to_MSV2_COLUMN_SCHEMAS = {
   ),
   "FLAG": MSv2ColumnSchema("FLAG", ("frequency", "polarization"), 1, None),
   "VISIBILITY": MSv2ColumnSchema(
-    "DATA", ("frequency", "polarization"), np.nan + np.nan * 1j, VisiblityCoder()
+    "DATA", ("frequency", "polarization"), np.nan + np.nan * 1j, VisibilityCoder()
   ),
   "WEIGHT_ROW": MSv2ColumnSchema(
     "WEIGHT",

{xarray_ms-0.3.8 → xarray_ms-0.5.0}/xarray_ms/backend/msv2/measures_adapters.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import typing
 from abc import ABC, abstractmethod
 from dataclasses import dataclass
-from typing import TYPE_CHECKING, Any, Dict, Literal, Sequence, overload
+from typing import TYPE_CHECKING, Any, Dict, Literal, Sequence, get_args, overload
 
 import numpy as np
 
@@ -17,7 +17,7 @@ from xarray_ms.casa_types import (
   UvwMeasures,
 )
 from xarray_ms.errors import (
-  ComplexMeasuremetSet,
+  ComplexMeasurementSet,
   InvalidMeasurementSet,
   MissingMeasuresInfo,
   MissingQuantumUnits,
@@ -28,6 +28,8 @@ from xarray_ms.errors import (
 if TYPE_CHECKING:
   import pyarrow as pa
 
+OnMissingType = Literal["none", "raise"]
+
 
 @dataclass
 class MeasuresData:
@@ -45,9 +47,9 @@ CASA_MEASURES_MAP = {
 }
 
 
-def raise_invalid_on_missing(on_missing: Literal["none", "raise"]):
-  if on_missing not in {"none", "raise"}:
-    raise ValueError(f"'on_missing' {on_missing} not in {{'none', 'raise'}}")
+def raise_invalid_on_missing(on_missing: OnMissingType):
+  if on_missing not in get_args(OnMissingType):
+    raise ValueError(f"'on_missing' {on_missing} not in {get_args(OnMissingType)}")
 
 
 def raise_on_measinfo_indirection(column_name: str, measinfo: Dict[str, Any]):
@@ -57,19 +59,8 @@ def raise_on_measinfo_indirection(column_name: str, measinfo: Dict[str, Any]):
   i.e. if it has a ``VarRefCol`` for defining a per-row frame or
   ``RefOff*`` keywords for defining offsets.
   """
-
-  def check() -> bool:
-    for k in measinfo:
-      if "VarRefCol" in k:
-        return True
-
-      if k.startswith("RefOff"):
-        return True
-
-    return False
-
-  if check():
-    raise ComplexMeasuremetSet(
+  if any("VarRefCol" in k or k.startswith("RefOff") for k in measinfo):
+    raise ComplexMeasurementSet(
       f"The MEASINFO in column {column_name} {measinfo} "
       f"contains indirection in the form of `VarRefCol` "
       f"or `RefCol*` entries. "
@@ -93,7 +84,7 @@ class MeasuresMixin:
   ) -> Dict[str, Any]: ...
 
   def extract_measinfo(
-    self, column_desc: ColumnDesc, on_missing: Literal["none", "raise"] = "none"
+    self, column_desc: ColumnDesc, on_missing: OnMissingType = "none"
   ) -> Dict[str, Any] | None:
     """Extracts the MEASINFO keyword from the column descriptor, if present"""
     try:
@@ -118,7 +109,7 @@ class MeasuresMixin:
   ) -> str: ...
 
   def extract_quantum_unit(
-    self, column_desc: ColumnDesc, on_missing: Literal["none", "raise"] = "none"
+    self, column_desc: ColumnDesc, on_missing: OnMissingType = "none"
   ) -> str | None:
     """Attempts to extract a single quantum unit from the keywords
     of the column descriptor.
@@ -164,7 +155,7 @@ class MeasuresMixin:
   ) -> str: ...
 
   def extract_msv2_type(
-    self, column_desc: ColumnDesc, on_missing: Literal["none", "raise"] = "none"
+    self, column_desc: ColumnDesc, on_missing: OnMissingType = "none"
   ) -> str | None:
     """Returns the msv2 measures type, derived from the 'type' keyword
     in the column descriptor keywords"""
@@ -202,7 +193,7 @@ class MeasuresMixin:
   ) -> str: ...
 
   def extract_msv4_type(
-    self, column_desc: ColumnDesc, on_missing: Literal["none", "raise"] = "none"
+    self, column_desc: ColumnDesc, on_missing: OnMissingType = "none"
   ) -> str | None:
     """Returns the msv4 measures type, derived from the 'type' keyword
     in the column descriptor keywords"""
@@ -249,26 +240,26 @@ class AbstractMeasuresAdapter(ABC):
   def msv2_frame(self, on_missing: Literal["raise"]) -> str: ...
 
   @abstractmethod
-  def msv2_frame(self, on_missing: Literal["none", "raise"] = "none") -> str | None:
+  def msv2_frame(self, on_missing: OnMissingType = "none") -> str | None:
     """Returns the MSv2 Measures frame.
 
     This corresponds to ``MEASINFO['Ref']`` or possibly ``MEASINFO['VarRefCol']``"""
     raise NotImplementedError
 
   @abstractmethod
-  def msv2_type(self, on_missing: Literal["none", "raise"] = "none") -> str | None:
+  def msv2_type(self, on_missing: OnMissingType = "none") -> str | None:
     """Returns the MSv2 Measures type.
 
     This corresponds to ``MEASINFO['type']`` in the column descriptor keywords"""
     raise NotImplementedError
 
   @abstractmethod
-  def msv4_type(self, on_missing: Literal["none", "raise"] = "none") -> str | None:
+  def msv4_type(self, on_missing: OnMissingType = "none") -> str | None:
     """Return the MSv4 Measures type"""
     raise NotImplementedError
 
   @abstractmethod
-  def quantum_unit(self, on_missing: Literal["none", "raise"] = "none") -> str | None:
+  def quantum_unit(self, on_missing: OnMissingType = "none") -> str | None:
     """Returns a single unit associated with this measure.
 
     This corresponds to ``MEASINFO['QuantumUnits']`` in the
@@ -300,13 +291,13 @@ class ColumnDescMeasuresAdapter(AbstractMeasuresAdapter, MeasuresMixin):
   def column_name(self) -> str:
     return self._column_desc.name
 
-  def quantum_unit(self, on_missing: Literal["none", "raise"] = "none") -> str | None:
+  def quantum_unit(self, on_missing: OnMissingType = "none") -> str | None:
     return self.extract_quantum_unit(self._column_desc, on_missing=on_missing)
 
-  def msv2_type(self, on_missing: Literal["none", "raise"] = "none"):
+  def msv2_type(self, on_missing: OnMissingType = "none"):
     return self.extract_msv2_type(self._column_desc, on_missing=on_missing)
 
-  def msv4_type(self, on_missing: Literal["none", "raise"] = "none") -> str | None:
+  def msv4_type(self, on_missing: OnMissingType = "none") -> str | None:
     return self.extract_msv4_type(self._column_desc, on_missing=on_missing)
 
   @overload
@@ -315,7 +306,7 @@ class ColumnDescMeasuresAdapter(AbstractMeasuresAdapter, MeasuresMixin):
   @overload
   def msv2_frame(self, on_missing: Literal["raise"]) -> str: ...
 
-  def msv2_frame(self, on_missing: Literal["none", "raise"] = "none") -> str | None:
+  def msv2_frame(self, on_missing: OnMissingType = "none") -> str | None:
     if (
       measinfo := self.extract_measinfo(self._column_desc, on_missing=on_missing)
     ) is None:
@@ -359,7 +350,7 @@ class ArrowTableMeasuresAdapter(ColumnDescMeasuresAdapter, MeasuresMixin):
   @overload
   def msv2_frame(self, on_missing: Literal["raise"]) -> str: ...
 
-  def msv2_frame(self, on_missing: Literal["none", "raise"] = "none") -> str | None:
+  def msv2_frame(self, on_missing: OnMissingType = "none") -> str | None:
     if (
       measinfo := self.extract_measinfo(self._column_desc, on_missing=on_missing)
     ) is None:
@@ -389,7 +380,11 @@ class ArrowTableMeasuresAdapter(ColumnDescMeasuresAdapter, MeasuresMixin):
       # The measures information may contain it's own reference types and codes
       if isinstance(tab_ref_types := measinfo.get("TabRefTypes"), Sequence):
         if isinstance(tab_ref_codes := measinfo.get("TabRefCodes"), Sequence):
-          assert len(tab_ref_types) == len(tab_ref_codes)
+          if len(tab_ref_types) != len(tab_ref_codes):
+            raise InvalidMeasurementSet(
+              f"TabRefTypes {tab_ref_types} and TabRefCodes {tab_ref_codes} "
+              f"have different lengths in {self.column_name} MEASINFO"
+            )
         else:
           tab_ref_codes = [MeasuresEnum[t].value for t in tab_ref_types]
 
@@ -399,7 +394,15 @@ class ArrowTableMeasuresAdapter(ColumnDescMeasuresAdapter, MeasuresMixin):
         code_frame_map = {m.value: m.name for m in MeasuresEnum}
 
       # Try and find a unique frame
-      if len(frames := {code_frame_map[c] for c in var_ref_col}) == 0:
+      try:
+        frames = {code_frame_map[c] for c in var_ref_col}
+      except KeyError as e:
+        raise InvalidMeasurementSet(
+          f"Code {e.args[0]} in {var_ref_col_name} is not in the "
+          f"code frame map {code_frame_map} for column {self.column_name}"
+        ) from e
+
+      if len(frames) == 0:
         return None
 
       if len(frames) > 1:

{xarray_ms-0.3.8 → xarray_ms-0.5.0}/xarray_ms/backend/msv2/measures_encoders.py

@@ -107,21 +107,6 @@ class MeasuresCoder(MSv2Coder):
     self.measures_adapter = measures_adapter
 
 
-class QuantityCoder(MeasuresCoder):
-  """Encodes a quantum unit"""
-
-  def encode(self, variable: Variable, name: T_Name = None) -> Variable:
-    dims, data, attrs, encoding = unpack_for_encoding(variable)
-    attrs = {k: v for k, v in attrs.items() if k not in {"type", "units"}}
-    return Variable(dims, data, attrs, encoding, fastpath=True)
-
-  def decode(self, variable: Variable, name: T_Name = None) -> Variable:
-    dims, data, attrs, encoding = unpack_for_decoding(variable)
-    attrs["type"] = "quantity"
-    attrs["units"] = self.measures_adapter.quantum_unit("raise")
-    return Variable(dims, data, attrs, encoding, fastpath=True)
-
-
 class SuppliedAttributesCoder(MSv2Coder):
   """Adds and removes the supplied attributes during decoding and encoding"""
 
@@ -149,7 +134,7 @@ class SuppliedQuantityCoder(SuppliedAttributesCoder):
     super().__init__({"type": "quantity", "units": units})
 
 
-class VisiblityCoder(SuppliedQuantityCoder):
+class VisibilityCoder(SuppliedQuantityCoder):
   """Visibility coder"""
 
   def __init__(self):
@@ -227,7 +212,7 @@ class EpochCoder(MeasuresCoder):
 
   def decode(self, variable: Variable, name: T_Name = None) -> Variable:
     dims, data, attrs, encoding = unpack_for_decoding(variable)
-    attrs["type"] = self.measures_adapter.msv4_type()
+    attrs["type"] = self.measures_adapter.msv4_type("raise")
     attrs["units"] = self.measures_adapter.quantum_unit("raise")
     attrs["format"] = "unix"
     if (msv2_frame := self.measures_adapter.msv2_frame("raise")) == "UTC":

{xarray_ms-0.3.8 → xarray_ms-0.5.0}/xarray_ms/errors.py

@@ -39,7 +39,7 @@ class InvalidMeasurementSet(ValueError):
   """Raised when the Measurement Set is invalid in some way"""
 
 
-class ComplexMeasuremetSet(ValueError):
+class ComplexMeasurementSet(ValueError):
   """Raised when complexity in the Measurement Set prevents processing"""