ENH: add xvec accessor and to_crs, set_crs, geom_coords_names

ci/dev.yaml

@@ -7,6 +7,7 @@ dependencies:
   # to build from source
   - cython
   - geos
+  - proj
   # testing
   - pytest
   - pytest-cov
@@ -16,3 +17,4 @@ dependencies:
   - pip:
       - git+https://github.com/shapely/shapely.git@main
       - git+https://github.com/pydata/xarray.git@main
+      - git+https://github.com/pyproj4/pyproj.git

ci/latest.yaml

@@ -7,6 +7,7 @@ dependencies:
   # required
   - shapely=2
   - xarray
+  - pyproj
   # testing
   - pytest
   - pytest-cov

doc/source/api.rst

@@ -4,6 +4,9 @@
 API reference
 =============
 
+The API reference provides an overview of all public objects, functions and
+methods and Xarray accessors implemented in Xvec.
+
 Indexing
 --------
 
@@ -15,3 +18,65 @@ Indexing
    GeometryIndex
    GeometryIndex.crs
    GeometryIndex.sindex
+
+
+.. currentmodule:: xarray
+
+Dataset.xvec
+------------
+
+.. _dsattr:
+
+Properties
+~~~~~~~~~~
+
+.. autosummary::
+   :toctree: generated/
+   :template: autosummary/accessor_attribute.rst
+
+    Dataset.xvec.geom_coords
+    Dataset.xvec.geom_coords_indexed
+
+
+.. _dsmeth:
+
+Methods
+~~~~~~~
+
+.. autosummary::
+   :toctree: generated/
+   :template: autosummary/accessor_method.rst
+
+    Dataset.xvec.is_geom_variable
+    Dataset.xvec.set_crs
+    Dataset.xvec.to_crs
+
+
+DataArray.xvec
+--------------
+
+.. _daattr:
+
+Properties
+~~~~~~~~~~
+
+.. autosummary::
+   :toctree: generated/
+   :template: autosummary/accessor_attribute.rst
+
+    DataArray.xvec.geom_coords
+    DataArray.xvec.geom_coords_indexed
+
+
+.. _dameth:
+
+Methods
+~~~~~~~
+
+.. autosummary::
+   :toctree: generated/
+   :template: autosummary/accessor_method.rst
+
+    DataArray.xvec.is_geom_variable
+    DataArray.xvec.to_crs
+    DataArray.xvec.set_crs

doc/source/conf.py

@@ -5,6 +5,15 @@
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+import os
+import sys
+
+import sphinx_autosummary_accessors
+
+
+sys.path.insert(0, os.path.abspath("../xvec/"))
+
+import xvec  # noqa
 
 project = "Xvec"
 copyright = "2022, Xvec developers"
@@ -20,9 +29,13 @@
     "sphinx.ext.intersphinx",
     "myst_nb",
     "sphinx_copybutton",
+    "sphinx_autosummary_accessors",
 ]
 
-templates_path = ["_templates"]
+templates_path = [
+    "_templates",
+    sphinx_autosummary_accessors.templates_path,
+]
 exclude_patterns = []
 
 intersphinx_mapping = {
@@ -42,3 +55,4 @@
     "github_url": "https://github.com/martinfleis/xvec",
 }
 nb_execution_mode = "off"
+autodoc_typehints = "none"

environment.yml

@@ -22,3 +22,6 @@ dependencies:
   - flake8
   - black
   - isort
+  - pip
+  - pip:
+      - sphinx_autosummary_accessors

pyproject.toml

@@ -27,7 +27,7 @@ classifiers = [
 ]
 requires-python = ">=3.8"
 dependencies = [
-    "xarray >= 2022.11.0",
+    "xarray >= 2022.12.0",
     "pyproj >= 3.0.0",
     "shapely >= 2.0b1",
 ]

xvec/__init__.py

@@ -1,5 +1,6 @@
 from importlib.metadata import PackageNotFoundError, version
 
+from .accessor import XvecAccessor  # noqa
 from .index import GeometryIndex  # noqa
 
 try: