freva-xarray to xarray-prism

Author: tropicrainforest

.github/workflows/release_ci.yml

@@ -45,10 +45,10 @@
               RC="${{ github.event_name == 'workflow_dispatch' && inputs.rc || '' }}"
               IS_PRERELEASE="false"
               if [ "$RC" ]; then
-                 python3 rc.py rc $RC freva_xarray -p . 1> tag.txt
+                 python3 rc.py rc $RC xarray_prism -p . 1> tag.txt
                  IS_PRERELEASE="true"
               else
-                 python3 -c "exec(open('src/freva_xarray/_version.py').read()); print(__version__)" 1> tag.txt
+                 python3 -c "exec(open('src/xarray_prism/_version.py').read()); print(__version__)" 1> tag.txt
               fi
               echo "$IS_PRERELEASE" > is_prerelease.txt
               echo "is_prerelease=$IS_PRERELEASE" >> "$GITHUB_OUTPUT"
@@ -116,7 +116,7 @@
 
           - name: Update version for pre-release
             run: |
-              sed -i "s/__version__ = .*/__version__ = \"${{ env.TAG }}\"/" src/freva_xarray/_version.py
+              sed -i "s/__version__ = .*/__version__ = \"${{ env.TAG }}\"/" src/xarray_prism/_version.py
 
           - name: Build package
             run: python -m build

.github/workflows/tests_ci.yml

@@ -41,7 +41,7 @@ jobs:
         uses: mamba-org/setup-micromamba@v1
         with:
           micromamba-version: "latest"
-          environment-name: freva-xarray
+          environment-name: xarray-prism
           cache-environment: true
           cache-downloads: true
           create-args: >-

README.md

@@ -5,7 +5,7 @@ and ability to register new data format and uri type for climate data.
 
 > [!Important]
 > If you deal with a data that `freva` engine is not able to open that, please
-> report the data [here](https://github.com/freva-org/freva-xarray/issues/new)
+> report the data [here](https://github.com/freva-org/xarray-prism/issues/new)
 > to let us improve this engine to be able to be versitile and work with all
 > sort of climate data.
 
@@ -15,13 +15,13 @@ and ability to register new data format and uri type for climate data.
 ### Install via PyPI
 
 ```bash
-pip install freva-xarray
+pip install xarray-prism
 ```
 
 ### Install via Conda
 
 ```bash
-conda install freva-xarray
+conda install xarray-prism
 ```
 
 ## Quick Start
@@ -138,14 +138,14 @@ xr.open_dataset(
 > 
 > Unlike Zarr or HDF5, these formats don't support partial/chunk reads over the network.
 > 
-> By default, freva-xarray caches files in the system temp directory. 
+> By default, xarray-prism caches files in the system temp directory. 
 > This works well for most cases. 
 > If temp storage is a concern (e.g., limited space or cleared on reboot), 
 > you can specify a persistent cache:
 > 
 > | Option | How |
 > |--------|-----|
-> | Environment variable | `export FREVA_XARRAY_CACHE=/path/to/cache` |
+> | Environment variable | `export xarray_prism_CACHE=/path/to/cache` |
 > | Per-call | `storage_options={"simplecache": {"cache_storage": "/path"}}` |
 > | Default | System temp directory |
 
@@ -154,31 +154,31 @@ xr.open_dataset(
 
 ### Custom Format Detectors and URI Types
 
-You can extend **freva-xarray** with custom *format detectors*, *URI types*, and *open handlers* by providing a small plugin package.
+You can extend **xarray-prism** with custom *format detectors*, *URI types*, and *open handlers* by providing a small plugin package.
 Registration happens **at import time**, so importing the plugin activates it.
 
 ### Plugin structure
 
 ```text
-freva_xarray_myplugin/
+xarray_prism_myplugin/
   __init__.py   # imports the plugin module (triggers registration)
   plugin.py     # detectors, URI types, and open handlers
 pyproject.toml
 ```
 
 ### Plugin implementation
 
-`freva_xarray_myplugin/__init__.py`
+`xarray_prism_myplugin/__init__.py`
 
 ```python
 from .plugin import *  # noqa: F401,F403
 ```
 
-`freva_xarray_myplugin/plugin.py`
+`xarray_prism_myplugin/plugin.py`
 
 ```python
 import xarray as xr
-from freva_xarray import register_detector, register_uri_type, registry
+from xarray_prism import register_detector, register_uri_type, registry
 
 
 @register_uri_type(priority=100)
@@ -210,20 +210,20 @@ def open_foo_from_myfs(uri: str, **kwargs):
 
 ```toml
 [project]
-name = "freva-xarray-myplugin"
+name = "xarray-prism-myplugin"
 version = "0.1.0"
-dependencies = ["freva-xarray"]
+dependencies = ["xarray-prism"]
 
-[project.entry-points."freva_xarray.plugins"]
-myplugin = "freva_xarray_myplugin"
+[project.entry-points."xarray_prism.plugins"]
+myplugin = "xarray_prism_myplugin"
 ```
 
 ### Using the plugin
 
 After installing the plugin package, **import it once** to activate the registrations:
 
 ```python
-import freva_xarray_myplugin  # activates detectors and handlers
+import xarray_prism_myplugin  # activates detectors and handlers
 
 import xarray as xr
 ds = xr.open_dataset("myfs://bucket/path/data.foo", engine="freva")
@@ -239,8 +239,8 @@ ds = xr.open_dataset("myfs://bucket/path/data.foo", engine="freva")
 docker-compose -f dev-env/docker-compose.yaml up -d --remove-orphans
 
 # Create conda environment
-conda create -n freva-xarray python=3.12 -y
-conda activate freva-xarray
+conda create -n xarray-prism python=3.12 -y
+conda activate xarray-prism
 
 # Install package in editable mode with dev dependencies
 pip install -e ".[dev]"

dev-env/docker-compose.yaml

@@ -3,7 +3,7 @@ services:
 
   minio:
     networks:
-      - freva-xarray
+      - xarray-prism
     image: quay.io/minio/minio
     hostname: minio
     environment:
@@ -21,7 +21,7 @@ services:
 
   setup-minio:
     networks:
-      - freva-xarray
+      - xarray-prism
     image: quay.io/minio/mc
     environment:
        MINIO_ROOT_USER: minioadmin
@@ -46,5 +46,5 @@ services:
       - ./thredds/content/catalog.xml:/usr/local/tomcat/content/thredds/catalog.xml
       - ../data:/data:ro
 networks:
-  freva-xarray:
+  xarray-prism:
     driver: bridge

pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools>=61.0", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "freva-xarray"
+name = "xarray-prism"
 dynamic = ["version"]
 description = "A multi-format and multi-storage xarray engine with automatic engine detection, and ability to register new data format and uri type for climate data."
 readme = "README.md"
@@ -50,19 +50,19 @@ dev = [
 ]
 
 [project.urls]
-Issues = "https://github.com/freva-org/freva-xarray/issues"
-Source = "https://github.com/freva-org/freva-xarray/"
+Issues = "https://github.com/freva-org/xarray-prism/issues"
+Source = "https://github.com/freva-org/xarray-prism/"
 
 # IMPORTANT: Register as xarray backend, auto-discovered by xarray
 [project.entry-points."xarray.backends"]
-freva = "freva_xarray.entrypoint:FrevaBackendEntrypoint"
+freva = "xarray_prism.entrypoint:FrevaBackendEntrypoint"
 [tool.codespell]
 ignore-words-list = "iterm"
 [tool.setuptools.dynamic]
-version = {attr = "freva_xarray._version.__version__"}
+version = {attr = "xarray_prism._version.__version__"}
 [tool.setuptools.packages.find]
 where = ["src"]
-include = ["freva_xarray*"]
+include = ["xarray_prism*"]
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
@@ -84,7 +84,7 @@ python_version = "3.10"
 warn_return_any = true
 warn_unused_configs = true
 ignore_missing_imports = true
-files = "src/freva_xarray"
+files = "src/xarray_prism"
 strict = false
 follow_imports = "silent"
 
@@ -95,7 +95,7 @@ target-version = ["py39", "py310", "py311", "py312", "py313", "py314"]
 [tool.isort]
 profile = "black"
 line_length = 88
-known_first_party = ["freva_xarray"]
+known_first_party = ["xarray_prism"]
 
 [tool.flake8]
 ignore = ["F405", "F403", "E704", "W503", "C901"]
@@ -140,7 +140,7 @@ deps =
     -e .[dev]
     pytest-env
 commands =
-    python3 -m pytest -vv --cov=freva_xarray --cov-report=html:coverage_report --cov-report=xml --junitxml=report.xml tests/ {posargs}
+    python3 -m pytest -vv --cov=xarray_prism --cov-report=html:coverage_report --cov-report=xml --junitxml=report.xml tests/ {posargs}
     python3 -m coverage report --fail-under=80 --precision=2
 
 [testenv:lint]
@@ -152,10 +152,10 @@ deps =
     flake8
     codespell
 commands =
-    python3 -m isort --check --profile black -t py39 -l 88 src/freva_xarray
-    python3 -m black --check src/freva_xarray tests
-    python3 -m flake8 src/freva_xarray --count --max-complexity=10 --ignore=F405,F403,E704,W503,C901 --max-line-length=88 --statistics --show-source
-    codespell --quiet-level=2 src/freva_xarray
+    python3 -m isort --check --profile black -t py39 -l 88 src/xarray_prism
+    python3 -m black --check src/xarray_prism tests
+    python3 -m flake8 src/xarray_prism --count --max-complexity=10 --ignore=F405,F403,E704,W503,C901 --max-line-length=88 --statistics --show-source
+    codespell --quiet-level=2 src/xarray_prism
 
 [testenv:types]
 description = "Static type checking."
@@ -164,16 +164,16 @@ deps =
     mypy
     types-setuptools
 commands =
-    python3 -m mypy src/freva_xarray --ignore-missing-imports
+    python3 -m mypy src/xarray_prism --ignore-missing-imports
 
 [testenv:format]
 description = "Auto-format code."
 deps =
     black
     isort
 commands =
-    python3 -m isort --profile black -t py39 -l 88 src/freva_xarray tests
-    python3 -m black src/freva_xarray tests
+    python3 -m isort --profile black -t py39 -l 88 src/xarray_prism tests
+    python3 -m black src/xarray_prism tests
 
 [testenv:release]
 description = "Tag a new release."
@@ -183,7 +183,7 @@ deps =
     requests
     tomli
 commands =
-    python3 bump.py tag freva_xarray -p .
+    python3 bump.py tag xarray_prism -p .
 allowlist_externals =
     rm
     curl
@@ -200,7 +200,7 @@ deps =
     requests
     tomli
 commands =
-    python3 bump.py deploy freva_xarray -p .
+    python3 bump.py deploy xarray_prism -p .
 allowlist_externals =
     rm
     curl

src/freva_xarray/_registry.py

@@ -1,4 +1,4 @@
-"""Registry for custom backends for freva_xarray."""
+"""Registry for custom backends for xarray_prism."""
 
 from __future__ import annotations
 

src/freva_xarray/_version.py

@@ -1,3 +1,3 @@
-"""Version information for freva-xarray."""
+"""Version information for xarray-prism."""
 
 __version__ = "2512.0.14"

src/freva_xarray/backends/cloud.py

@@ -18,7 +18,7 @@
 
 def _get_cache_dir(storage_options: Optional[Dict] = None) -> Path:
     """Get cache directory."""
-    env_cache = os.environ.get("FREVA_XARRAY_CACHE")
+    env_cache = os.environ.get("XARRAY_PRISM_CACHE")
     # 1. Environment variable
     if env_cache:
         cache_root = Path(env_cache)
@@ -32,7 +32,7 @@ def _get_cache_dir(storage_options: Optional[Dict] = None) -> Path:
             cache_root.mkdir(parents=True, exist_ok=True)
             return cache_root
     # 3. Default temp directory
-    cache_root = Path(tempfile.gettempdir()) / "freva-xarray-cache"
+    cache_root = Path(tempfile.gettempdir()) / "xarray-prism-cache"
     cache_root.mkdir(parents=True, exist_ok=True)
     return cache_root
 

src/freva_xarray/entrypoint.py

@@ -73,7 +73,7 @@ class FrevaBackendEntrypoint(BackendEntrypoint):
         "and entrypoint registry for new formats and URI types."
     )
 
-    url = "https://github.com/freva-org/freva-xarray"
+    url = "https://github.com/freva-org/xarray-prism"
     open_dataset_parameters = ("filename_or_obj", "drop_variables")
 
     ENGINE_MAP: Dict[str, str] = {

tests/test_backends.py

@@ -8,7 +8,7 @@
 import pytest
 import xarray as xr
 
-from freva_xarray.backends import open_cloud, open_posix
+from xarray_prism.backends import open_cloud, open_posix
 
 
 class TestPosixBackend:
@@ -106,7 +106,7 @@ def test_open_netcdf_from_s3(self, s3_env: dict):
     def test_open_grib_from_s3_with_cache(self, s3_env: dict, temp_cache_dir: Path):
         """Open a GRIB file from S3 with local caching."""
         uri = "s3://testdata/test.grib2"
-        os.environ["FREVA_XARRAY_CACHE"] = str(temp_cache_dir)
+        os.environ["xarray_prism_CACHE"] = str(temp_cache_dir)
 
         try:
             ds = open_cloud(
@@ -128,7 +128,7 @@ def test_open_grib_from_s3_with_cache(self, s3_env: dict, temp_cache_dir: Path):
                 pytest.skip(f"S3/cfgrib setup issue: {e}")
             raise
         finally:
-            os.environ.pop("FREVA_XARRAY_CACHE", None)
+            os.environ.pop("xarray_prism_CACHE", None)
 
     @pytest.mark.requires_minio
     def test_open_geotiff_from_s3(self, s3_env: dict):
@@ -172,18 +172,18 @@ class TestCacheConfiguration:
 
     def test_cache_dir_from_env(self, temp_cache_dir: Path):
         """Cache directory should be configurable via environment."""
-        from freva_xarray.backends.cloud import _get_cache_dir
+        from xarray_prism.backends.cloud import _get_cache_dir
 
-        os.environ["FREVA_XARRAY_CACHE"] = str(temp_cache_dir)
+        os.environ["xarray_prism_CACHE"] = str(temp_cache_dir)
         try:
             cache_dir = _get_cache_dir()
             assert cache_dir == temp_cache_dir
         finally:
-            os.environ.pop("FREVA_XARRAY_CACHE", None)
+            os.environ.pop("xarray_prism_CACHE", None)
 
     def test_cache_dir_from_storage_options(self, temp_cache_dir: Path):
         """Cache directory should be configurable via storage_options."""
-        from freva_xarray.backends.cloud import _get_cache_dir
+        from xarray_prism.backends.cloud import _get_cache_dir
 
         storage_options = {
             "simplecache": {"cache_storage": str(temp_cache_dir)},
@@ -193,11 +193,11 @@ def test_cache_dir_from_storage_options(self, temp_cache_dir: Path):
 
     def test_cache_dir_default(self):
         """Default cache should be in temp directory."""
-        from freva_xarray.backends.cloud import _get_cache_dir
+        from xarray_prism.backends.cloud import _get_cache_dir
         import tempfile
 
-        os.environ.pop("FREVA_XARRAY_CACHE", None)
+        os.environ.pop("xarray_prism_CACHE", None)
 
         cache_dir = _get_cache_dir()
         assert cache_dir.parent == Path(tempfile.gettempdir())
-        assert "freva-xarray-cache" in str(cache_dir)
+        assert "xarray-prism-cache" in str(cache_dir)