Improve partition

CHANGELOG.rst

@@ -4,11 +4,11 @@ Changelog
 
 v0.11.0 (unreleased)
 --------------------
-Contributors to this version: Gabriel Rondeau-Genesse (:user:`RondeauG`).
+Contributors to this version: Gabriel Rondeau-Genesse (:user:`RondeauG`), Juliette Lavoie (:user:`juliettelavoie`).
 
 New features and enhancements
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-* N/A
+* Improve ``xs.ensembles.build_partition_data``. (:pull:`504`).
 
 Breaking changes
 ^^^^^^^^^^^^^^^^

docs/notebooks/4_ensembles.ipynb

@@ -169,19 +169,28 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "is_executing": true
+   },
    "outputs": [],
    "source": [
     "# Get catalog\n",
     "from pathlib import Path\n",
     "\n",
+    "import xclim as xc\n",
+    "\n",
     "output_folder = Path().absolute() / \"_data\"\n",
     "cat = xs.DataCatalog(str(output_folder / \"tutorial-catalog.json\"))\n",
     "\n",
     "# create a dictionnary of datasets wanted for the partition\n",
     "input_dict = cat.search(variable=\"tas\", member=\"r1i1p1f1\").to_dataset_dict(\n",
     "    xarray_open_kwargs={\"engine\": \"h5netcdf\"}\n",
-    ")"
+    ")\n",
+    "datasets = {}\n",
+    "for k, v in input_dict.items():\n",
+    "    ds = xc.atmos.tg_mean(v.tas).to_dataset()\n",
+    "    ds.attrs = v.attrs\n",
+    "    datasets[k] = ds"
    ]
   },
   {
@@ -204,9 +213,8 @@
     "import xclim as xc\n",
     "\n",
     "ds = xs.ensembles.build_partition_data(\n",
-    "    input_dict,\n",
+    "    datasets,\n",
     "    subset_kw=dict(name=\"mtl\", method=\"gridpoint\", lat=[45.5], lon=[-73.6]),\n",
-    "    indicators_kw={\"indicators\": [xc.atmos.tg_mean]},\n",
     ")\n",
     "ds"
    ]

environment-dev.yml

@@ -30,10 +30,10 @@ dependencies:
   - shapely >=2.0
   - sparse
   - toolz
-  - xarray >=2023.11.0, !=2024.6.0
-  - xclim >=0.53.2, <0.54
+  - xarray >=2023.11.0, !=2024.6.0, <2024.10.0 #FIXME: 2024.10.0 breaks rechunker with zarr, https://github.com/pangeo-data/rechunker/issues/154
+  - xclim >=0.54, <0.55
   - xesmf >=0.7, <0.8.8  # FIXME: 0.8.8 currently creates segfaults on ReadTheDocs.
-  - zarr >=2.13
+  - zarr >=2.13, <3.0 #FIXME: xarray is compatible with zarr 3.0 from 2025.01.1, but we pin xarray below that version
   # Opt
   - nc-time-axis >=1.3.1
   - pyarrow >=10.0.1
@@ -56,6 +56,7 @@ dependencies:
   - pandoc
   - pooch
   - pre-commit >=3.5.0
+  - pygments <2.19 #FIXME: temporary fix, https://github.com/felix-hilden/sphinx-codeautolink/issues/153
   - pytest >=8.3.2
   - pytest-cov >=5.0.0
   - pytest-xdist >=3.2.0

environment.yml

@@ -30,10 +30,10 @@ dependencies:
   - shapely >=2.0
   - sparse
   - toolz
-  - xarray >=2023.11.0, !=2024.6.0
-  - xclim >=0.53.2, <0.54
+  - xarray >=2023.11.0, !=2024.6.0, <2024.10.0 #FIXME: 2024.10.0 breaks rechunker with zarr
+  - xclim >=0.54, <0.55
   - xesmf >=0.7, <0.8.8  # FIXME: 0.8.8 currently creates segfaults on ReadTheDocs.
-  - zarr >=2.13
+  - zarr >=2.13, <3.0 #FIXME: xarray is compatible with zarr 3.0 from 2025.01.1, but we pin xarray below that version
   # To install from source
   - setuptools >=65.0.0
   - setuptools-scm >=8.0.0

pyproject.toml

@@ -65,9 +65,9 @@ dependencies = [
   "shapely >=2.0",
   "sparse",
   "toolz",
-  "xarray >=2023.11.0, !=2024.6.0",
-  "xclim >=0.53.2, <0.54",
-  "zarr >=2.13"
+  "xarray >=2023.11.0, !=2024.6.0, <2024.10.0", # FIXME: 2024.10.0 breaks rechunker with zarr
+  "xclim >=0.54, <0.55",
+  "zarr >=2.13, <3.0" # FIXME: xarray is compatible with zarr 3.0 from 2025.01.1, but we pin xarray below that version"
 ]
 
 [project.optional-dependencies]
@@ -109,7 +109,8 @@ docs = [
   "sphinx-intl",
   "sphinx-mdinclude",
   "sphinx-rtd-theme >=1.0",
-  "sphinxcontrib-napoleon"
+  "sphinxcontrib-napoleon",
+  "pygments <2.19" # FIXME: temporary fix, https://github.com/felix-hilden/sphinx-codeautolink/issues/153
 ]
 extra = [
   "xesmf>=0.7, <0.8.8" # FIXME: 0.8.8 currently creates segfaults on ReadTheDocs.