Add oblique mercator to create_bounds and other improvements to the regridding function

CHANGELOG.rst

@@ -23,6 +23,8 @@ New features and enhancements
 * New argument ``compute_indicators``: ``rechunk_input`` to rechunk the inputs to resample-appropriate chunks before calling xclim. (:pull:`431`).
 * New ``xs.indicators.get_indicator_outputs`` to retrieve what variable name(s) and frequency to expect from an xclim indicator. (:pull:`431`).
 * `xscen` now supports launches tests from `pytest` with the `--numprocesses` option. See the `pytest-xdist documentation <https://pytest-xdist.readthedocs.io/en/stable/>`_ for more information. (:pull:`464`).
+* Conservative regridding now supports oblique mercator projections. (:pull:`467`).
+* The automatic name for the weight file in ``regrid_dataset`` is now more explicit to avoid errors, but now requires `cat:id` and `cat:domain` arguments for both the source and target datasets. (:pull:`467`).
 
 Bug fixes
 ^^^^^^^^^
@@ -48,6 +50,9 @@ Breaking changes
 * Python 3.9 is no longer supported. (:pull:`456`).
 * Functions and arguments that were deprecated in `xscen` v0.8.0 or earlier have been removed. (:pull:`461`).
 * `pytest-xdist` is now a development dependency. (:pull:`464`).
+* ``xs.regrid.create_bounds_rotated_pole`` has been renamed to ``xs.regrid.create_bounds_gridmapping``. (:pull:`467`).
+* The `weights_location` argument in ``regrid_dataset`` is no longer positional. (:pull:`467`).
+* The ``xs.regrid.create_mask`` function now requires explicit arguments instead of a dictionary. (:pull:`467`).
 
 Internal changes
 ^^^^^^^^^^^^^^^^

docs/notebooks/2_getting_started.ipynb

@@ -549,13 +549,7 @@
     "\n",
     "Masks can be used on both the original grid and the destination grid to ignore certain grid cells during the regridding process. These masks follow the `ESMF` convention, meaning that the mask is a variable within the Dataset, named *mask* and comprised of 0 and 1.\n",
     "\n",
-    "`xs.create_mask` will create an adequate DataArray, following the instructions given by *mask_args*. In the case of variables that have a time component, the first timestep will be chosen.\n",
-    "\n",
-    "     mask_args:\n",
-    "        - 'variable'         (optional)\n",
-    "        - 'where_operator'   (optional)\n",
-    "        - 'where_threshold'  (optional)\n",
-    "        - 'mask_nans': bool"
+    "`xs.create_mask` will create an adequate DataArray, following the instructions given to the function. In the case of variables that have a time component, the first timestep will be chosen."
    ]
   },
   {
@@ -567,23 +561,17 @@
    },
    "outputs": [],
    "source": [
-    "# Will mask all pixels that do not match these requirements (at least 25% land)\n",
-    "mask_args = {\n",
-    "    \"variable\": \"sftlf\",\n",
-    "    \"where_operator\": \">\",\n",
-    "    \"where_threshold\": 25,\n",
-    "    \"mask_nans\": True,\n",
-    "}\n",
-    "\n",
     "# to_dataset() will open the dataset, as long as the search() gave a single result.\n",
     "ds_example = pcat.search(\n",
     "    id=\"CMIP6_ScenarioMIP_NCC_NorESM2-MM_ssp245_r1i1p1f1_example-region\",\n",
     "    processing_level=\"extracted\",\n",
     "    variable=\"sftlf\",\n",
     ").to_dataset()\n",
     "\n",
-    "# Masking function\n",
-    "ds_example[\"mask\"] = xs.create_mask(ds_example, mask_args=mask_args)"
+    "# Will mask all pixels that do not match these requirements (at least 25% land)\n",
+    "ds_example[\"mask\"] = xs.create_mask(\n",
+    "    ds_example, variable=\"sftlf\", where_operator=\">\", where_threshold=25, mask_nans=True\n",
+    ")"
    ]
   },
   {
@@ -716,7 +704,7 @@
     "        pcat.search(\n",
     "            id=ds.attrs[\"cat:id\"], processing_level=\"extracted\", variable=\"sftlf\"\n",
     "        ).to_dataset(),\n",
-    "        mask_args=mask_args,\n",
+    "        **mask_args,\n",
     "    )\n",
     "\n",
     "    # Regridding function\n",

environment-dev.yml

@@ -29,8 +29,8 @@ dependencies:
   - shapely >=2.0
   - sparse
   - toolz
-  - xarray >=2023.11.0, !=2024.6.0
-  - xclim >=0.52.2, <0.53
+  - xarray >=2023.11.0,!=2024.6.0
+  - xclim >=0.52.2,<0.53
   - xesmf >=0.7
   - zarr >=2.13
   # Opt

environment.yml

@@ -29,8 +29,8 @@ dependencies:
   - shapely >=2.0
   - sparse
   - toolz
-  - xarray >=2023.11.0, !=2024.6.0
-  - xclim >=0.52.2, <0.53
+  - xarray >=2023.11.0,!=2024.6.0
+  - xclim >=0.52.2,<0.53
   - xesmf >=0.7
   - zarr >=2.13
   # To install from source

pyproject.toml

@@ -64,8 +64,8 @@ dependencies = [
   "shapely >=2.0",
   "sparse",
   "toolz",
-  "xarray >=2023.11.0, !=2024.6.0",
-  "xclim >=0.52.2, <0.53",
+  "xarray >=2023.11.0,!=2024.6.0",
+  "xclim >=0.52.2,<0.53",
   "zarr >=2.13"
 ]