Merge branch 'main' into kvikio-entrypoint

Author: weiji14

.github/workflows/pypi-release.yaml

@@ -45,7 +45,7 @@ jobs:
         run: |
           python -m twine check dist/*
           pwd
-          if [ -f dist/cupy-xarray-0.0.0.tar.gz ]; then
+          if [ -f dist/cupy_xarray-0.0.0.tar.gz ]; then
             echo "❌ INVALID VERSION NUMBER"
             exit 1
           else
@@ -61,7 +61,7 @@ jobs:
     if: github.event_name == 'release'
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4.1.7
         with:
           name: releases
           path: dist

.pre-commit-config.yaml

@@ -9,7 +9,7 @@ exclude: |
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v5.0.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
@@ -21,32 +21,25 @@ repos:
       - id: mixed-line-ending
 
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.15.2
+    rev: v3.17.0
     hooks:
       - id: pyupgrade
         args:
           - "--py38-plus"
 
-  - repo: https://github.com/psf/black
-    rev: 24.3.0
-    hooks:
-      - id: black
-      - id: black-jupyter
-
   - repo: https://github.com/keewis/blackdoc
     rev: v0.3.9
     hooks:
       - id: blackdoc
 
-  - repo: https://github.com/PyCQA/flake8
-    rev: 7.0.0
-    hooks:
-      - id: flake8
-
-  - repo: https://github.com/PyCQA/isort
-    rev: 5.13.2
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.9
     hooks:
-      - id: isort
+      - id: ruff
+        types_or: [python, pyi, jupyter]
+        args: [--fix]
+      - id: ruff-format
+        types_or: [python, pyi, jupyter]
 
   - repo: https://github.com/pre-commit/mirrors-prettier
     rev: v4.0.0-alpha.8

.readthedocs.yml

@@ -2,9 +2,9 @@
 version: 2
 
 build:
-  os: "ubuntu-20.04"
+  os: "ubuntu-24.04"
   tools:
-    python: "mambaforge-4.10"
+    python: "mambaforge-23.11"
 
 # Optionally set the version of Python and requirements required to build your docs
 conda:

MANIFEST.in

@@ -1,11 +1,9 @@
 include versioneer.py
 include cupy_xarray/_version.py
-include requirements.txt
 include LICENSE
 include README.md
 include pyproject.toml
 prune cupy_xarray/tests*
 
-
 recursive-exclude * __pycache__
 recursive-exclude * *.py[co]

README.md

@@ -16,6 +16,8 @@ Interface for using cupy in xarray, providing convenience accessors.
 
 ## Installation
 
+> `cupy-xarray` will use an existing cupy installation, hence cupy needs to be installed manually! Please follow cupy's install instructions at <https://docs.cupy.dev/en/stable/install.html>.
+
 From anaconda:
 
 ```console

ci/doc.yml

@@ -12,7 +12,7 @@ dependencies:
   - ipython
   - ipykernel
   - ipywidgets
-  - furo
+  - furo>=2024.8.6
   - myst-nb
   - xarray
   - zarr

cupy_xarray/accessors.py

@@ -1,14 +1,33 @@
-import cupy as cp
+import warnings
+from typing import TYPE_CHECKING, Any
+
+try:
+    import cupy as cp
+except ImportError as e:
+    warnings.warn(
+        "Cupy is not installed. cupy-xarray expects cupy to be manually installed. Please install "
+        "cupy by following the instructions at https://docs.cupy.dev/en/stable/install.html.",
+        ImportWarning,
+        stacklevel=2,
+    )
+    raise e
 from xarray import (
     DataArray,
     Dataset,
     register_dataarray_accessor,
     register_dataset_accessor,
 )
-from xarray.namedarray.pycompat import DuckArrayModule
 
-dsk = DuckArrayModule("dask")
-dask_array_type = dsk.type
+if TYPE_CHECKING:
+    DuckArrayTypes = tuple[type[Any], ...]
+    dask_array_type: DuckArrayTypes
+
+try:
+    import dask.array
+
+    dask_array_type = (dask.array.Array,)
+except ImportError:
+    dask_array_type = ()
 
 
 @register_dataarray_accessor("cupy")
@@ -55,7 +74,7 @@ def as_cupy(self):
         >>> da = xr.tutorial.load_dataset("air_temperature").air
         >>> gda = da.cupy.as_cupy()
         >>> type(gda.data)
-        <class 'cupy.core.core.ndarray'>
+        <class 'cupy.ndarray'>
 
         """
         if isinstance(self.da.data, dask_array_type):
@@ -127,7 +146,7 @@ def is_cupy(self):
         is_cupy: bool
             Whether the underlying data is a cupy array.
         """
-        return all([da.cupy.is_cupy for da in self.ds.data_vars.values()])
+        return all(da.cupy.is_cupy for da in self.ds.data_vars.values())
 
     def as_cupy(self):
         """

cupy_xarray/tests/test_accessors.py

@@ -1,10 +1,16 @@
 import numpy as np
 import pytest
 import xarray as xr
-from xarray.core.pycompat import dask_array_type
 
 import cupy_xarray  # noqa: F401
 
+try:
+    import dask.array
+
+    dask_array_type = dask.array.Array
+except ImportError:
+    dask_array_type = None
+
 
 @pytest.fixture
 def tutorial_ds_air():

docs/api.rst

@@ -1,5 +1,5 @@
-API
-===
+API Reference
+=============
 
 .. currentmodule:: xarray
 

docs/changelog.md

@@ -0,0 +1,98 @@
+# Changelog
+
+## Version 0.1.4 - 2024-07-27
+
+This release brings several documentation improvements at
+<https://cupy-xarray.readthedocs.io> with a new User Guide, Tutorials and Presentations,
+Contributing Guide and API reference. It also fixes a `No module named
+'xarray.core.pycompat'` bug, and will require a minimum version of `xarray>=2024.02.0`.
+
+### What's Changed
+
+- Documentation Updates 📖 ([#35](https://github.com/xarray-contrib/cupy-xarray/pull/35))
+- Update accessors.py ([#42](https://github.com/xarray-contrib/cupy-xarray/pull/42))
+- Enable API reference docs to show accessor methods ([#44](https://github.com/xarray-contrib/cupy-xarray/pull/44))
+- Migrate flake8, isort, black rules to ruff ([#49](https://github.com/xarray-contrib/cupy-xarray/pull/49))
+- Fix broken doctest and tests on accessors ([#46](https://github.com/xarray-contrib/cupy-xarray/pull/46))
+- Migrate from setup.cfg to pyproject.toml ([#48](https://github.com/xarray-contrib/cupy-xarray/pull/48))
+
+### Contributors
+
+- [Wei Ji Leong](https://github.com/weiji14)
+- [Negin Sobhani](https://github.com/negin513)
+- [Sai Shashank](https://github.com/saishashank85)
+
+**Full Changelog**: <https://github.com/xarray-contrib/cupy-xarray/compare/0.1.3...0.1.4>
+
+---
+
+## Version 0.1.3 - 2023-02-22
+
+### What's Changed
+
+- Set encoding for Windows ([#20](https://github.com/xarray-contrib/cupy-xarray/pull/20))
+- Fix broken dask_array_type import ([#24](https://github.com/xarray-contrib/cupy-xarray/pull/24))
+- Min xarray >= 0.19.0 ([#25](https://github.com/xarray-contrib/cupy-xarray/pull/25))
+- Expand installation doc ([#27](https://github.com/xarray-contrib/cupy-xarray/pull/27))
+
+### Contributors
+
+- [Deepak Cherian](https://github.com/dcherian)
+- [Aaron Zuspan](https://github.com/aazuspan)
+- [Aleksandr Kadykov](https://github.com/kadykov)
+
+**Full Changelog**: <https://github.com/xarray-contrib/cupy-xarray/compare/0.1.2...0.1.3>
+
+---
+
+## Version 0.1.2 - 2022-08-25
+
+### What's Changed
+
+- Add badges ([#16](https://github.com/xarray-contrib/cupy-xarray/pull/16))
+- update PyPI workflow: double-check we're shipping everything we need ([#17](https://github.com/xarray-contrib/cupy-xarray/pull/17))
+- PyPI workflow: re-introduce upload job ([#18](https://github.com/xarray-contrib/cupy-xarray/pull/18))
+- Revert back to previous version of PyPI workflow ([#19](https://github.com/xarray-contrib/cupy-xarray/pull/19))
+
+### Contributors
+
+- [Deepak Cherian](https://github.com/dcherian)
+- [Anderson Banihirwe](https://github.com/andersy005)
+
+**Full Changelog**: <https://github.com/xarray-contrib/cupy-xarray/compare/0.1.1...0.1.2>
+
+---
+
+## Version 0.1.1 - 2022-08-19
+
+_First release!_
+
+### What's Changed
+
+- Add LICENSE ([#2](https://github.com/xarray-contrib/cupy-xarray/pull/2))
+- Update path of repo ([#3](https://github.com/xarray-contrib/cupy-xarray/pull/3))
+- Add docs ([#4](https://github.com/xarray-contrib/cupy-xarray/pull/4))
+- Update versioneer ([#12](https://github.com/xarray-contrib/cupy-xarray/pull/12))
+- Add PyPI release workflow ([#13](https://github.com/xarray-contrib/cupy-xarray/pull/13))
+- Fix CI job dependency ([#14](https://github.com/xarray-contrib/cupy-xarray/pull/14))
+
+### Contributors
+
+- [Jacob Tomlinson](https://github.com/jacobtomlinson)
+- [Ray Bell](https://github.com/raybellwaves)
+- [Deepak Cherian](https://github.com/dcherian)
+- [Anderson Banihirwe](https://github.com/andersy005)
+
+**Full Changelog**: <https://github.com/xarray-contrib/cupy-xarray/compare/0.1.0...0.1.1>
+
+---
+
+## Version 0.1.0 - 2020-07-23
+
+_Pre-release_
+
+### Contributors
+
+- [Jacob Tomlinson](https://github.com/jacobtomlinson)
+
+**Full Changelog**: <https://github.com/xarray-contrib/cupy-xarray/compare/0.0.1...0.1.0>

docs/conf.py

@@ -11,9 +11,9 @@
 import cupy_xarray  # noqa: F401
 
 project = "cupy-xarray"
-copyright = "2023, cupy-xarray developers"
+copyright = "2020-2024, cupy-xarray developers"
 author = "cupy-xarray developers"
-release = "v0.1"
+release = "v0.1.4"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

docs/index.md

@@ -16,6 +16,8 @@ CuPy-Xarray is a Python library that leverages [CuPy](https://cupy.dev/), a GPU
 
 ## Installation
 
+> `cupy-xarray` will use an existing cupy installation, hence cupy needs to be installed manually! Please follow cupy's install instructions at <https://docs.cupy.dev/en/stable/install.html>.
+
 CuPy-Xarray can be installed using `pip` or `conda`:
 
 From Conda Forge:
@@ -77,11 +79,12 @@ Large parts of this documentations comes from [SciPy 2023 Xarray on GPUs tutoria
    source/contributing
 
 
-**API Reference**:
+**Reference**:
 
 .. toctree::
    :maxdepth: 1
-   :caption: API Reference
+   :caption: Reference
 
    api
+   changelog
 ```

docs/source/contributing.rst

@@ -132,7 +132,7 @@ Running the test suite
 *cupy-xarray* uses the `pytest <https://docs.pytest.org/en/latest/contents.html>`_
 framework for testing. You can run the test suite using::
 
-    pytest cupy-xarray
+    pytest --doctest-modules cupy_xarray
 
 Contributing documentation
 ==========================

pyproject.toml

@@ -1,3 +1,53 @@
-[tool.black]
-line-length = 100
-target-version = ['py38']
+[build-system]
+requires = ["setuptools", "versioneer[toml]"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "cupy-xarray"
+description = "Interface for using cupy in xarray, providing convenience accessors."
+authors = [{name = "cupy-xarray developers"}]
+license = {text = "Apache License"}
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+dynamic = ["version"]
+dependencies = [
+    "xarray>=2024.02.0",
+]
+
+[project.optional-dependencies]
+test = [
+    "dask",
+    "pytest",
+]
+
+[tool.ruff]
+line-length = 100  # E501 (line-too-long)
+exclude = [
+    "docs",
+    "versioneer.py",
+    "cupy_xarray/_version.py",
+]
+
+[tool.ruff.lint]
+select = [
+    "B",    # flake8-bugbear
+    "C4",   # flake8-comprehensions
+    "C90",  # mccabe
+    "E",    # pycodestyle
+    "F",    # pyflakes
+    "I",    # isort
+    "SIM",  # flake8-simplify
+    "W",    # pycodestyle warnings
+]
+
+[tool.versioneer]
+VCS = "git"
+style = "pep440"
+versionfile_source = "cupy_xarray/_version.py"
+versionfile_build = "cupy_xarray/_version.py"
+tag_prefix = ""
+parentdir_prefix = ""