diff --git a/docs/api.rst b/docs/api.rst index d93c3cbc..1ced17a3 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -123,8 +123,6 @@ Methods Dataset.temporal.climatology Dataset.temporal.departures Dataset.regridder.horizontal - Dataset.regridder.horizontal_xesmf - Dataset.regridder.horizontal_regrid2 Dataset.regridder.vertical .. _dsmeth_1: @@ -184,5 +182,5 @@ It is especially useful for those who are transitioning over from CDAT to xarray - ``Dataset.temporal.departures("VAR_KEY", freq=<"season"|"month"|"day">)``, subset results for individual seasons, months, or days - ``cdutil.SEASONALCYCLE.departures()``, ``cdutil.ANNUALCYCLE.departures()``, ``cdutil..departures()``, ``cdutil..departures()`` * - Regrid horizontally? - - ``Dataset.regridder.horizontal_regrid2()``, ``Dataset.regridder.horizontal_xesmf()`` + - ``Dataset.regridder.horizontal(tool="regrid2")`` - ``cdms2.regrid2()`` diff --git a/docs/examples/regridding-horizontal.ipynb b/docs/examples/regridding-horizontal.ipynb index c8032cec..e4825a5a 100644 --- a/docs/examples/regridding-horizontal.ipynb +++ b/docs/examples/regridding-horizontal.ipynb @@ -1,7 +1,6 @@ { "cells": [ { - "attachments": {}, "cell_type": "markdown", "id": "a31785d6-310c-4871-9ac6-064a7874945f", "metadata": { @@ -12,7 +11,7 @@ "\n", "Author: [Jason Boutte](https://github.com/jasonb5)\n", "\n", - "Date: 08/24/22\n", + "Date: 09/26/22\n", "\n", "Related APIs:\n", "\n", @@ -30,19 +29,35 @@ { "cell_type": "code", "execution_count": 1, - "id": "f44514d3-c3a5-446f-bc32-a914ef5cfb6a", - "metadata": {}, + "id": "1f96db06-2871-484f-b2dc-423afdf32c0c", + "metadata": { + "tags": [] + }, "outputs": [], "source": [ "%matplotlib inline\n", "\n", + "import os\n", + "import sys\n", + "os.environ[\"ESMFMKFILE\"] = sys.prefix + \"/lib/esmf.mk\" # TODO remove after esmf>=8.5\n", + "import xesmf" + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "id": "cd0e239e-d3e0-445d-a149-21a648008369", + "metadata": { + "tags": [] + }, + "outputs": [], + "source": [ "import matplotlib.pyplot as plt\n", "import xarray as xr\n", "import xcdat" ] }, { - "attachments": {}, "cell_type": "markdown", "id": "7d904843-4079-4ebe-a3d0-ab439e8ce052", "metadata": {}, @@ -56,9 +71,11 @@ }, { "cell_type": "code", - "execution_count": 2, + "execution_count": 3, "id": "7e51beb4-a48b-49ca-9a28-4057886b8e51", - "metadata": {}, + "metadata": { + "tags": [] + }, "outputs": [ { "data": { @@ -324,6 +341,11 @@ " grid-column: 4;\n", "}\n", "\n", + ".xr-index-preview {\n", + " grid-column: 2 / 5;\n", + " color: var(--xr-font-color2);\n", + "}\n", + "\n", ".xr-var-name,\n", ".xr-var-dims,\n", ".xr-var-dtype,\n", @@ -345,14 +367,16 @@ "}\n", "\n", ".xr-var-attrs,\n", - ".xr-var-data {\n", + ".xr-var-data,\n", + ".xr-index-data {\n", " display: none;\n", " background-color: var(--xr-background-color) !important;\n", " padding-bottom: 5px !important;\n", "}\n", "\n", ".xr-var-attrs-in:checked ~ .xr-var-attrs,\n", - ".xr-var-data-in:checked ~ .xr-var-data {\n", + ".xr-var-data-in:checked ~ .xr-var-data,\n", + ".xr-index-data-in:checked ~ .xr-index-data {\n", " display: block;\n", "}\n", "\n", @@ -362,13 +386,16 @@ "\n", ".xr-var-name span,\n", ".xr-var-data,\n", + ".xr-index-name div,\n", + ".xr-index-data,\n", ".xr-attrs {\n", " padding-left: 25px !important;\n", "}\n", "\n", ".xr-attrs,\n", ".xr-var-attrs,\n", - ".xr-var-data {\n", + ".xr-var-data,\n", + ".xr-index-data {\n", " grid-column: 1 / -1;\n", "}\n", "\n", @@ -406,7 +433,8 @@ "}\n", "\n", ".xr-icon-database,\n", - ".xr-icon-file-text2 {\n", + ".xr-icon-file-text2,\n", + ".xr-no-icon {\n", " display: inline-block;\n", " vertical-align: middle;\n", " width: 1em;\n", @@ -424,9 +452,9 @@ " height float64 2.0\n", "Dimensions without coordinates: bnds\n", "Data variables:\n", - " time_bnds (time, bnds) object 1850-01-01 00:00:00 ... 2015-01-01 00:00:00\n", - " lat_bnds (lat, bnds) float64 -90.0 -86.58 -86.58 ... 86.58 86.58 90.0\n", - " lon_bnds (lon, bnds) float64 -1.406 1.406 1.406 ... 355.8 355.8 358.6\n", + " time_bnds (time, bnds) object ...\n", + " lat_bnds (lat, bnds) float64 ...\n", + " lon_bnds (lon, bnds) float64 ...\n", " tas (time, lat, lon) float32 -25.04 -25.28 -25.49 ... -25.93 -25.73\n", "Attributes: (12/54)\n", " CCCma_model_hash: 7e8e715f3f2ce47e1bab830db971c362ca329419\n", @@ -441,14 +469,14 @@ " version: v20190429\n", " license: CMIP6 model data produced by The Governm...\n", " cmor_version: 3.4.0\n", - " DODS_EXTRA.Unlimited_Dimension: time