xarray-ms 0.3.2__tar.gz → 0.3.7__tar.gz

xarray_ms-0.3.7/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,15 @@
+- xarray-ms version:
+- Python version:
+- Operating System:
+
+### Description
+
+Describe what you were trying to accomplish.
+Tell us what happened, what went wrong, and what you expected to happen.
+
+### Reproducer and Error Logs
+
+```
+Paste the command(s) you ran and the output.
+If there was a crash, please include the traceback here.
+```

xarray_ms-0.3.7/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,16 @@
+<!--
+Consider opening an enhancement issue
+if the change is large or complex.
+https://github.com/ratt-ru/xarray-ms/issues/new/choose
+
+Development setup information is available at the following url:
+https://xarray-ms.readthedocs.io/en/latest/install.html#development
+-->
+
+Thanks for contributing to xarray-ms.
+
+We would appreciate it if you could add:
+
+- [ ] Test Cases covering your PR.
+- [ ] Documentation.
+- [ ] A Changelog entry in `doc/source/changelog.rst`.

xarray_ms-0.3.7/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

xarray_ms-0.3.7/.github/workflows/ci.yml

@@ -0,0 +1,137 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches:
+    - main
+    tags:
+    - "*"
+  pull_request:
+  schedule:
+    - cron: '30 2 * * 1,4' # Every Monday and Thursday @ 2h30am UTC
+
+jobs:
+  check_skip:
+    runs-on: ubuntu-latest
+    if: |
+      !contains(format('{0} {1} {2}', github.event.head_commit.message, github.event.pull_request.title, github.event.pull_request.body), '[skip ci]')
+    steps:
+      - run: |
+          cat <<'MESSAGE'
+          github.event_name: ${{ toJson(github.event_name) }}
+          github.event:
+          ${{ toJson(github.event) }}
+          MESSAGE
+  test:
+    needs: check_skip
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ["ubuntu-22.04", "macos-13", "macos-14", "macos-15"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+        is_main_or_release:
+          - ${{ contains(github.ref, 'main') || startsWith(github.ref, 'refs/tags')}}
+        exclude:
+          # Don't test on macos-{13,14} in PR's
+          - is_main_or_release: false
+            os: "macos-13"
+          - is_main_or_release: false
+            os: "macos-14"
+          # Don't test on 3.10 - 3.12 in PR's
+          - is_main_or_release: false
+            python-version: "3.10"
+          - is_main_or_release: false
+            python-version: "3.11"
+          - is_main_or_release: false
+            python-version: "3.12"
+          # Don't test on macos on 3.10 - 3.12 in PRs
+          - os: "macos-13"
+            python-version: "3.10"
+          - os: "macos-13"
+            python-version: "3.11"
+          - os: "macos-13"
+            python-version: "3.12"
+          - os: "macos-14"
+            python-version: "3.10"
+          - os: "macos-14"
+            python-version: "3.11"
+          - os: "macos-14"
+            python-version: "3.12"
+          - os: "macos-15"
+            python-version: "3.10"
+          - os: "macos-15"
+            python-version: "3.11"
+          - os: "macos-15"
+            python-version: "3.12"
+
+
+    steps:
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Checkout source
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 1
+
+      - name: Download metadata
+        run: curl https://downloadnrao.org/file.download.json > metadata.json
+
+      - name: Load cached MSv4 Test Corpus
+        id: load-cached-msv4-test-corpus
+        uses: actions/cache@v4
+        with:
+          key: msv4-test-corpus-${{ hashFiles('metadata.json')}}
+          path: ~/.cache/xarray-ms/msv4-test-data
+
+      - name: Create virtual environment
+        run: |
+          python -m venv .venv
+          source .venv/bin/activate
+          pip install -U pip
+
+      - name: Install xarray-ms
+        run: |
+          source .venv/bin/activate
+          pip install .[testing]
+
+      - name: Test xarray-ms
+        run: |
+          source .venv/bin/activate
+          py.test -s -vvv tests/ -Werror --msv4_test_corpus
+
+      # - name: Debug with tmate on failure
+      #   if: ${{ failure() }}
+      #   uses: mxschmitt/action-tmate@v3
+
+  deploy:
+    needs: [test]
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https:/pypi.org/p/xarray-ms
+    permissions:
+      id-token: write
+    steps:
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v6
+        with:
+          python-version: 3.11
+
+      - name: Checkout source
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 1
+
+      - name: Build distributions
+        run: |
+          pip install -U pip build
+          python -m build --sdist --wheel
+
+      - name: Publish distribution 📦 to PyPI
+        if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
+        uses: pypa/gh-action-pypi-publish@release/v1

xarray_ms-0.3.7/.github/workflows/pre-commit.yml

@@ -0,0 +1,15 @@
+name: pre-commit
+
+on: [push]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v5
+      with:
+        fetch-depth: 1
+    - uses: actions/setup-python@v6
+      with:
+        python-version: 3.11
+    - uses: pre-commit/action@v3.0.1

xarray_ms-0.3.7/.github/workflows/readthedocs.yml

@@ -0,0 +1,22 @@
+# .github/workflows/documentation-links.yml
+
+name: readthedocs/actions
+on:
+  pull_request_target:
+    types:
+      - opened
+    # Execute this action only on PRs that touch
+    # documentation files.
+    # paths:
+    #   - "doc/**"
+
+permissions:
+  pull-requests: write
+
+jobs:
+  documentation-links:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: readthedocs/actions/preview@v1
+        with:
+          project-slug: "xarray-ms"

xarray_ms-0.3.7/.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

xarray_ms-0.3.7/.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.3
+    hooks:
+    -   id: ruff
+        # Handle imports, see
+        # https://github.com/astral-sh/ruff/issues/8232
+        # https://github.com/astral-sh/ruff/issues/10882
+        args: [ --fix, --extend-select, I ]
+    -   id: ruff-format
+        name: ruff format
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.17.0
+    hooks:
+    -   id: mypy
+        name: mypy
+        additional_dependencies: [types-requests]

xarray_ms-0.3.7/.readthedocs.yaml

@@ -0,0 +1,23 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - doc
+        - testing
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: doc/source/conf.py

xarray_ms-0.3.7/PKG-INFO

@@ -0,0 +1,47 @@
+Metadata-Version: 2.4
+Name: xarray-ms
+Version: 0.3.7
+Summary: xarray MSv4 views over MSv2 Measurement Sets
+Author-email: Simon Perkins <simon.perkins@gmail.com>
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: arcae<0.4.0,>=0.3.2
+Requires-Dist: cacheout>=0.16.0
+Requires-Dist: typing-extensions>=4.12.2
+Requires-Dist: xarray<2025.9.1,>=2025.0
+Provides-Extra: dev
+Requires-Dist: pre-commit>=3.8.0; extra == 'dev'
+Requires-Dist: tbump>=6.11.0; extra == 'dev'
+Provides-Extra: doc
+Requires-Dist: ipython>=8.27.0; extra == 'doc'
+Requires-Dist: pydata-sphinx-theme>=0.15.4; extra == 'doc'
+Requires-Dist: pygments>=2.18.0; extra == 'doc'
+Requires-Dist: sphinx-copybutton>=0.5.2; extra == 'doc'
+Requires-Dist: sphinx>=8.0.2; extra == 'doc'
+Requires-Dist: sphinxcontrib-spelling; extra == 'doc'
+Provides-Extra: testing
+Requires-Dist: dask>=2024.5.0; extra == 'testing'
+Requires-Dist: distributed>=2024.5.0; extra == 'testing'
+Requires-Dist: platformdirs>=4.3.8; extra == 'testing'
+Requires-Dist: pytest>=8.0.0; extra == 'testing'
+Requires-Dist: zarr<3.0.0,>=2.18.3; extra == 'testing'
+Description-Content-Type: text/x-rst
+
+xarray-ms
+=========
+
+|CI Status| |Doc Status| |Version Status|
+
+xarray-ms presents an xarray Measurement Set v4 view over a CASA Measurement Set v2.
+See the documentation_ for further information.
+
+.. _documentation: https://xarray-ms.readthedocs.io
+.. |CI Status| image:: https://github.com/ratt-ru/xarray-ms/actions/workflows/ci.yml/badge.svg
+   :target: https://github.com/ratt-ru/xarray-ms/actions/workflows/ci.yml
+   :alt: Continuous Integration Status
+.. |Doc Status| image:: https://readthedocs.org/projects/xarray-ms/badge/?version=latest
+   :target: https://xarray-ms.readthedocs.io/en/latest/?badge=latest
+   :alt: Documentation Status
+.. |Version Status| image:: https://img.shields.io/pypi/v/xarray-ms.svg
+   :target: https://pypi.python.org/pypi/xarray-ms
+   :alt: Version Status

xarray_ms-0.3.7/doc/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

xarray_ms-0.3.7/doc/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

xarray_ms-0.3.7/doc/source/api.rst

@@ -0,0 +1,31 @@
+API
+===
+
+Opening Measurement Sets
+------------------------
+
+The standard :func:`xarray.open_datatree` method should
+be used to open a :class:`~xarray.DataTree` interface
+to the underlying Measurement Set data.
+
+.. code-block:: python
+
+    >>> datatree = xarray.open_datatree("/data/data.ms", partition_schema=["FIELD_ID"])
+
+These methods defer to the relevant methods on the
+`Entrypoint Class <entrypoint-class_>`_.
+Consult the method signatures for information on extra
+arguments that can be passed.
+
+
+.. _entrypoint-class:
+
+Entrypoint Class
+----------------
+
+Entrypoint class for the MSv2 backend.
+
+.. autoclass:: xarray_ms.backend.msv2.entrypoint.MSv2EntryPoint
+    :members: open_datatree, open_dataset
+
+.. _partitioning-schema: