Merge pull request #422 from w-k-jones/release_1.5.3

Release 1.5.3
tobac-project · Mar 22, 2024 · 2fe56c0 · 2fe56c0
2 parents 3a8ffba + e86ff81
commit 2fe56c0
Show file tree

Hide file tree

Showing 21 changed files with 1,789 additions and 1,612 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,26 @@
 ### Tobac Changelog
 
+_**Version 1.5.3:**_
+
+**Enhancements for Users**
+
+- Update `calculate_area` to allow the calculation of the projected 2D area of 3D objects, and enhance bulk statistics to allow calculation of statistics on the projected footprint on 2D fields [#378](https://github.com/tobac-project/tobac/pull/378)
+
+**Bug fixes**
+
+- Fix a bug in `get_spacing` that would return a negative value if one coordinate was in ascending order and the other in descending order, and fix other bugs where the wrong coordinate was referenced [#400](https://github.com/tobac-project/tobac/pull/400)
+
+**Documentation**
+
+- Re-integration of notebooks from the tobac-tutorials repo [#334](https://github.com/tobac-project/tobac/pull/334)
+- Add example gallery to readthedocs page [#411](https://github.com/tobac-project/tobac/pull/411)
+
+**Internal Enhancements**
+
+- Add ability to save whether iris to xarray conversion ocurred and update decorators to allow keyword parameters [#380](https://github.com/tobac-project/tobac/pull/380)
+- Reorganisation of analysis tools into analysis package [#378](https://github.com/tobac-project/tobac/pull/378)
+
+
 _**Version 1.5.2:**_
 
 **Enhancements for Users**

diff --git a/doc/bulk_statistics/notebooks/compute_statistics_during_feature_detection.ipynb b/doc/bulk_statistics/notebooks/compute_statistics_during_feature_detection.ipynb
@@ -17,10 +17,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-02-17T13:15:49.602971Z",
-     "iopub.status.busy": "2024-02-17T13:15:49.602462Z",
-     "iopub.status.idle": "2024-02-17T13:15:51.108332Z",
-     "shell.execute_reply": "2024-02-17T13:15:51.106184Z"
+     "iopub.execute_input": "2024-03-22T17:18:35.329188Z",
+     "iopub.status.busy": "2024-03-22T17:18:35.328690Z",
+     "iopub.status.idle": "2024-03-22T17:18:36.372987Z",
+     "shell.execute_reply": "2024-03-22T17:18:36.372118Z"
     }
    },
    "outputs": [],
@@ -42,18 +42,18 @@
    "execution_count": 2,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-02-17T13:15:51.115152Z",
-     "iopub.status.busy": "2024-02-17T13:15:51.114024Z",
-     "iopub.status.idle": "2024-02-17T13:15:54.249193Z",
-     "shell.execute_reply": "2024-02-17T13:15:54.246812Z"
+     "iopub.execute_input": "2024-03-22T17:18:36.376438Z",
+     "iopub.status.busy": "2024-03-22T17:18:36.376057Z",
+     "iopub.status.idle": "2024-03-22T17:18:38.247466Z",
+     "shell.execute_reply": "2024-03-22T17:18:38.239280Z"
     }
    },
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "using tobac version 1.5.2\n"
+      "using tobac version 1.5.3\n"
      ]
     }
    ],
@@ -68,10 +68,10 @@
    "execution_count": 3,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-02-17T13:15:54.331271Z",
-     "iopub.status.busy": "2024-02-17T13:15:54.324629Z",
-     "iopub.status.idle": "2024-02-17T13:15:54.338758Z",
-     "shell.execute_reply": "2024-02-17T13:15:54.336986Z"
+     "iopub.execute_input": "2024-03-22T17:18:38.285861Z",
+     "iopub.status.busy": "2024-03-22T17:18:38.285093Z",
+     "iopub.status.idle": "2024-03-22T17:18:38.294187Z",
+     "shell.execute_reply": "2024-03-22T17:18:38.292554Z"
     }
    },
    "outputs": [],
@@ -98,10 +98,10 @@
    "execution_count": 4,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-02-17T13:15:54.351167Z",
-     "iopub.status.busy": "2024-02-17T13:15:54.349280Z",
-     "iopub.status.idle": "2024-02-17T13:15:54.367183Z",
-     "shell.execute_reply": "2024-02-17T13:15:54.365164Z"
+     "iopub.execute_input": "2024-03-22T17:18:38.322117Z",
+     "iopub.status.busy": "2024-03-22T17:18:38.321283Z",
+     "iopub.status.idle": "2024-03-22T17:18:38.331190Z",
+     "shell.execute_reply": "2024-03-22T17:18:38.324702Z"
     }
    },
    "outputs": [],
@@ -114,10 +114,10 @@
    "execution_count": 5,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-02-17T13:15:54.380965Z",
-     "iopub.status.busy": "2024-02-17T13:15:54.372136Z",
-     "iopub.status.idle": "2024-02-17T13:15:54.405551Z",
-     "shell.execute_reply": "2024-02-17T13:15:54.401789Z"
+     "iopub.execute_input": "2024-03-22T17:18:38.344343Z",
+     "iopub.status.busy": "2024-03-22T17:18:38.344007Z",
+     "iopub.status.idle": "2024-03-22T17:18:38.351035Z",
+     "shell.execute_reply": "2024-03-22T17:18:38.349141Z"
     }
    },
    "outputs": [],
@@ -149,10 +149,10 @@
    "execution_count": 6,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-02-17T13:15:54.424094Z",
-     "iopub.status.busy": "2024-02-17T13:15:54.421895Z",
-     "iopub.status.idle": "2024-02-17T13:15:54.722903Z",
-     "shell.execute_reply": "2024-02-17T13:15:54.721785Z"
+     "iopub.execute_input": "2024-03-22T17:18:38.370773Z",
+     "iopub.status.busy": "2024-03-22T17:18:38.366590Z",
+     "iopub.status.idle": "2024-03-22T17:18:38.505880Z",
+     "shell.execute_reply": "2024-03-22T17:18:38.504723Z"
     }
    },
    "outputs": [],
@@ -165,10 +165,10 @@
    "execution_count": 7,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-02-17T13:15:54.730863Z",
-     "iopub.status.busy": "2024-02-17T13:15:54.729948Z",
-     "iopub.status.idle": "2024-02-17T13:15:54.754780Z",
-     "shell.execute_reply": "2024-02-17T13:15:54.754021Z"
+     "iopub.execute_input": "2024-03-22T17:18:38.525114Z",
+     "iopub.status.busy": "2024-03-22T17:18:38.522164Z",
+     "iopub.status.idle": "2024-03-22T17:18:38.564211Z",
+     "shell.execute_reply": "2024-03-22T17:18:38.562792Z"
     }
    },
    "outputs": [
@@ -223,7 +223,7 @@
        "      margin-top: 7px;\n",
        "  }\n",
        "</style>\n",
-       "<table class=\"iris\" id=\"5155089680\">\n",
+       "<table class=\"iris\" id=\"5282387344\">\n",
        "    <tr class=\"iris\">\n",
        "<th class=\"iris iris-word-cell\">Surface Precipitation Average (mm h-1)</th>\n",
        "<th class=\"iris iris-word-cell\">time</th>\n",
@@ -333,10 +333,10 @@
    "execution_count": 8,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-02-17T13:15:54.762881Z",
-     "iopub.status.busy": "2024-02-17T13:15:54.759869Z",
-     "iopub.status.idle": "2024-02-17T13:15:54.770105Z",
-     "shell.execute_reply": "2024-02-17T13:15:54.767917Z"
+     "iopub.execute_input": "2024-03-22T17:18:38.578722Z",
+     "iopub.status.busy": "2024-03-22T17:18:38.575755Z",
+     "iopub.status.idle": "2024-03-22T17:18:38.586793Z",
+     "shell.execute_reply": "2024-03-22T17:18:38.584944Z"
     }
    },
    "outputs": [],
@@ -372,10 +372,10 @@
    "execution_count": 9,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-02-17T13:15:54.773843Z",
-     "iopub.status.busy": "2024-02-17T13:15:54.773535Z",
-     "iopub.status.idle": "2024-02-17T13:15:54.788479Z",
-     "shell.execute_reply": "2024-02-17T13:15:54.787618Z"
+     "iopub.execute_input": "2024-03-22T17:18:38.608207Z",
+     "iopub.status.busy": "2024-03-22T17:18:38.607420Z",
+     "iopub.status.idle": "2024-03-22T17:18:38.618440Z",
+     "shell.execute_reply": "2024-03-22T17:18:38.617527Z"
     }
    },
    "outputs": [],
@@ -412,10 +412,10 @@
    "execution_count": 10,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-02-17T13:15:54.796799Z",
-     "iopub.status.busy": "2024-02-17T13:15:54.796072Z",
-     "iopub.status.idle": "2024-02-17T13:15:54.803867Z",
-     "shell.execute_reply": "2024-02-17T13:15:54.803047Z"
+     "iopub.execute_input": "2024-03-22T17:18:38.635746Z",
+     "iopub.status.busy": "2024-03-22T17:18:38.635394Z",
+     "iopub.status.idle": "2024-03-22T17:18:38.642691Z",
+     "shell.execute_reply": "2024-03-22T17:18:38.640392Z"
     }
    },
    "outputs": [],
@@ -438,10 +438,10 @@
    "execution_count": 11,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-02-17T13:15:54.816776Z",
-     "iopub.status.busy": "2024-02-17T13:15:54.814862Z",
-     "iopub.status.idle": "2024-02-17T13:15:54.833273Z",
-     "shell.execute_reply": "2024-02-17T13:15:54.830306Z"
+     "iopub.execute_input": "2024-03-22T17:18:38.665578Z",
+     "iopub.status.busy": "2024-03-22T17:18:38.663868Z",
+     "iopub.status.idle": "2024-03-22T17:18:38.672653Z",
+     "shell.execute_reply": "2024-03-22T17:18:38.671135Z"
     }
    },
    "outputs": [],
@@ -454,10 +454,10 @@
    "execution_count": 12,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-02-17T13:15:54.839903Z",
-     "iopub.status.busy": "2024-02-17T13:15:54.839490Z",
-     "iopub.status.idle": "2024-02-17T13:16:19.461680Z",
-     "shell.execute_reply": "2024-02-17T13:16:19.460304Z"
+     "iopub.execute_input": "2024-03-22T17:18:38.691608Z",
+     "iopub.status.busy": "2024-03-22T17:18:38.691219Z",
+     "iopub.status.idle": "2024-03-22T17:18:56.451127Z",
+     "shell.execute_reply": "2024-03-22T17:18:56.450419Z"
     }
    },
    "outputs": [
@@ -504,10 +504,10 @@
    "execution_count": 13,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-02-17T13:16:19.466025Z",
-     "iopub.status.busy": "2024-02-17T13:16:19.465158Z",
-     "iopub.status.idle": "2024-02-17T13:16:19.491494Z",
-     "shell.execute_reply": "2024-02-17T13:16:19.490396Z"
+     "iopub.execute_input": "2024-03-22T17:18:56.455395Z",
+     "iopub.status.busy": "2024-03-22T17:18:56.454610Z",
+     "iopub.status.idle": "2024-03-22T17:18:56.477335Z",
+     "shell.execute_reply": "2024-03-22T17:18:56.476369Z"
     }
    },
    "outputs": [