Merge pull request #476 from w-k-jones/release_v1.5.5

Release v1.5.5
tobac-project · Dec 24, 2024 · be72676 · be72676
2 parents feeff81 + a7431f6
commit be72676
Show file tree

Hide file tree

Showing 23 changed files with 99,209 additions and 2,946 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,29 +1,38 @@
 ### Tobac Changelog
 
+_**Version 1.5.5:**_
+
+**Bug fixes**
+
+- Including of annotations import for python versions before 3.10 [#468](https://github.com/tobac-project/tobac/pull/468)
+- Fix bulk statistics calculation when provided a dask array [#474](https://github.com/tobac-project/tobac/pull/474)
+
+**Internal Enhancements**
+
+- Fix matrix testing to use the specified python versions [#468](https://github.com/tobac-project/tobac/pull/468)
+
+
 _**Version 1.5.4:**_
 
 **Enhancements for Users**
 
 - Added the ability to use the Minimum Euclidean Spanning Tree merge/split method on data with periodic boundaries [#372](https://github.com/tobac-project/tobac/pull/372)
 - Added the ability to calculate online bulk statistics during feature detection on the raw (i.e., unsmoothed) data [#449](https://github.com/tobac-project/tobac/pull/449)
 
-
 **Bug fixes**
 
 - Fixes to calculations of bulk statistics [#437](https://github.com/tobac-project/tobac/pull/437)
 - Fixes to handling of PBC feature points on the PBC wraparound border [#434](https://github.com/tobac-project/tobac/pull/434)
 - Fixed an error that allows non-matching features to be used in the offline bulk statistics calculation [#448](https://github.com/tobac-project/tobac/pull/448)
 - Fixed a bug that prevented using minimum distance filtering with varying vertical coordinates [#452](https://github.com/tobac-project/tobac/pull/452)
 
-
 **Documentation**
 
 - Add thumbnails to the new example gallery [#428](https://github.com/tobac-project/tobac/pull/428)
 - Added documentation for developers [#281](https://github.com/tobac-project/tobac/pull/281)
 - Updated documentation for the `n_min_threshold` function in feature detection [#432](https://github.com/tobac-project/tobac/pull/432)
 - Added documentation for dealing with big datasets [#408](https://github.com/tobac-project/tobac/pull/408)
-- Updated documentation to note that the *tobac* v1.5.0 paper in GMD is in its final form [#450](https://github.com/tobac-project/tobac/pull/450)
-- 
+- Updated documentation to note that the *tobac* v1.5.0 paper in GMD is in its final form [#450](https://github.com/tobac-project/tobac/pull/450) 
 
 **Internal Enhancements**
 
@@ -33,8 +42,6 @@ _**Version 1.5.4:**_
 - Resolved issues around updating dependencies in `black` formatting checks and Zenodo JSON checks [#457](https://github.com/tobac-project/tobac/pull/457)
 
 
-
-
 _**Version 1.5.3:**_
 
 **Enhancements for Users**

diff --git a/dev_requirements.txt b/dev_requirements.txt
@@ -13,3 +13,4 @@ pre-commit
 black
 pytest
 typing_extensions
+nbconvert
diff --git a/doc/big_datasets_examples/notebooks/parallel_processing_tobac.ipynb b/doc/big_datasets_examples/notebooks/parallel_processing_tobac.ipynb
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-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"
+     "iopub.execute_input": "2024-12-18T16:34:57.536123Z",
+     "iopub.status.busy": "2024-12-18T16:34:57.535676Z",
+     "iopub.status.idle": "2024-12-18T16:34:59.726971Z",
+     "shell.execute_reply": "2024-12-18T16:34:59.726626Z"
     }
    },
    "outputs": [],
@@ -43,18 +43,18 @@
    "execution_count": 2,
    "metadata": {
     "execution": {
-     "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"
+     "iopub.execute_input": "2024-12-18T16:34:59.728835Z",
+     "iopub.status.busy": "2024-12-18T16:34:59.728648Z",
+     "iopub.status.idle": "2024-12-18T16:35:03.032533Z",
+     "shell.execute_reply": "2024-12-18T16:35:03.032142Z"
     }
    },
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "using tobac version 1.5.3\n"
+      "using tobac version 1.5.5\n"
      ]
     }
    ],
@@ -70,10 +70,10 @@
    "execution_count": 3,
    "metadata": {
     "execution": {
-     "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"
+     "iopub.execute_input": "2024-12-18T16:35:03.062911Z",
+     "iopub.status.busy": "2024-12-18T16:35:03.062538Z",
+     "iopub.status.idle": "2024-12-18T16:35:03.065800Z",
+     "shell.execute_reply": "2024-12-18T16:35:03.065464Z"
     }
    },
    "outputs": [],
@@ -101,10 +101,10 @@
    "execution_count": 4,
    "metadata": {
     "execution": {
-     "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"
+     "iopub.execute_input": "2024-12-18T16:35:03.067687Z",
+     "iopub.status.busy": "2024-12-18T16:35:03.067569Z",
+     "iopub.status.idle": "2024-12-18T16:35:03.069638Z",
+     "shell.execute_reply": "2024-12-18T16:35:03.069263Z"
     }
    },
    "outputs": [],
@@ -117,10 +117,10 @@
    "execution_count": 5,
    "metadata": {
     "execution": {
-     "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"
+     "iopub.execute_input": "2024-12-18T16:35:03.071359Z",
+     "iopub.status.busy": "2024-12-18T16:35:03.071261Z",
+     "iopub.status.idle": "2024-12-18T16:35:03.074789Z",
+     "shell.execute_reply": "2024-12-18T16:35:03.074504Z"
     }
    },
    "outputs": [],
@@ -152,10 +152,10 @@
    "execution_count": 6,
    "metadata": {
     "execution": {
-     "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"
+     "iopub.execute_input": "2024-12-18T16:35:03.076370Z",
+     "iopub.status.busy": "2024-12-18T16:35:03.076279Z",
+     "iopub.status.idle": "2024-12-18T16:35:03.180069Z",
+     "shell.execute_reply": "2024-12-18T16:35:03.179738Z"
     }
    },
    "outputs": [],
@@ -168,10 +168,10 @@
    "execution_count": 7,
    "metadata": {
     "execution": {
-     "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"
+     "iopub.execute_input": "2024-12-18T16:35:03.182086Z",
+     "iopub.status.busy": "2024-12-18T16:35:03.181959Z",
+     "iopub.status.idle": "2024-12-18T16:35:03.193142Z",
+     "shell.execute_reply": "2024-12-18T16:35:03.192874Z"
     }
    },
    "outputs": [
@@ -226,7 +226,7 @@
        "      margin-top: 7px;\n",
        "  }\n",
        "</style>\n",
-       "<table class=\"iris\" id=\"5282387344\">\n",
+       "<table class=\"iris\" id=\"13383978256\">\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",
@@ -336,10 +336,10 @@
    "execution_count": 8,
    "metadata": {
     "execution": {
-     "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"
+     "iopub.execute_input": "2024-12-18T16:35:03.194946Z",
+     "iopub.status.busy": "2024-12-18T16:35:03.194809Z",
+     "iopub.status.idle": "2024-12-18T16:35:03.197103Z",
+     "shell.execute_reply": "2024-12-18T16:35:03.196874Z"
     }
    },
    "outputs": [],
@@ -375,10 +375,10 @@
    "execution_count": 9,
    "metadata": {
     "execution": {
-     "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"
+     "iopub.execute_input": "2024-12-18T16:35:03.199553Z",
+     "iopub.status.busy": "2024-12-18T16:35:03.199224Z",
+     "iopub.status.idle": "2024-12-18T16:35:03.203190Z",
+     "shell.execute_reply": "2024-12-18T16:35:03.202860Z"
     }
    },
    "outputs": [],
@@ -415,10 +415,10 @@
    "execution_count": 10,
    "metadata": {
     "execution": {
-     "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"
+     "iopub.execute_input": "2024-12-18T16:35:03.204782Z",
+     "iopub.status.busy": "2024-12-18T16:35:03.204699Z",
+     "iopub.status.idle": "2024-12-18T16:35:03.206631Z",
+     "shell.execute_reply": "2024-12-18T16:35:03.206290Z"
     }
    },
    "outputs": [],
@@ -441,10 +441,10 @@
    "execution_count": 11,
    "metadata": {
     "execution": {
-     "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"
+     "iopub.execute_input": "2024-12-18T16:35:03.208202Z",
+     "iopub.status.busy": "2024-12-18T16:35:03.208112Z",
+     "iopub.status.idle": "2024-12-18T16:35:03.209870Z",
+     "shell.execute_reply": "2024-12-18T16:35:03.209623Z"
     }
    },
    "outputs": [],
@@ -457,10 +457,10 @@
    "execution_count": 12,
    "metadata": {
     "execution": {
-     "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"
+     "iopub.execute_input": "2024-12-18T16:35:03.211256Z",
+     "iopub.status.busy": "2024-12-18T16:35:03.211172Z",
+     "iopub.status.idle": "2024-12-18T16:35:05.664457Z",
+     "shell.execute_reply": "2024-12-18T16:35:05.664167Z"
     }
    },
    "outputs": [
@@ -475,13 +475,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "feature detection done\n"
-     ]
-    },
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
+      "feature detection done\n",
       "features saved\n"
      ]
     }
@@ -509,10 +503,10 @@
    "execution_count": 13,
    "metadata": {
     "execution": {
-     "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"
+     "iopub.execute_input": "2024-12-18T16:35:05.666196Z",
+     "iopub.status.busy": "2024-12-18T16:35:05.665961Z",
+     "iopub.status.idle": "2024-12-18T16:35:05.675574Z",
+     "shell.execute_reply": "2024-12-18T16:35:05.675293Z"
     }
    },
    "outputs": [
@@ -753,7 +747,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.8"
+   "version": "3.11.6"
   }
  },
  "nbformat": 4,
-Original file line number
+Diff line change
@@ Expand Up / @@ -13,3 +13,4 @@ pre-commit @@
     black
     pytest
     typing_extensions
+    nbconvert