Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update version number, changelog and notebooks for 1.5.2 release #381

Merged
merged 6 commits into from
Dec 8, 2023
Merged

Update version number, changelog and notebooks for 1.5.2 release #381

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5943d85
Update version number to 1.5.2
w-k-jones Dec 6, 2023
628d930
Update changelog for 1.5.2 release
w-k-jones Dec 6, 2023
4f4c953
Update notebooks for 1.5.2 release
w-k-jones Dec 6, 2023
8e827e2
Add PR #384 to changelog
w-k-jones Dec 8, 2023
d40538f
Merge branch 'RC_v1.5.x' of https://github.com/climate-processes/toba…
w-k-jones Dec 8, 2023
47bd890
Update notebooks for release version of 1.5.2
w-k-jones Dec 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 36 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,40 @@
### Tobac Changelog

_**Version 1.5.2:**_

**Enhancements for Users**

- Let users optionally derive bulk statistics of the data points belonging to each feature. Bulk statistics can be calulcated during feature detection, segmentation or afterwards by applying one of more functions to each feature [#293](https://github.com/tobac-project/tobac/pull/293)
- Wrapped functions now show the correct docstring [#359](https://github.com/tobac-project/tobac/pull/359)

**Bug fixes**

- Fixed an out-of-bounds error that could occur when performing segmentation with PBCs [#350](https://github.com/tobac-project/tobac/pull/350)
- Path to data in example notebooks fixed after changes to zenodo [#357](https://github.com/tobac-project/tobac/pull/357)
- Bulk statistics updated to use multiple fields correctly and perform numpy-style broadcasting [#368](https://github.com/tobac-project/tobac/pull/368)
- PBCs now work when using predictive tracking [#376](https://github.com/tobac-project/tobac/pull/376)
- Fixed error with PBC distance calculation using numba if all of `min_h1`, `max_h1`, `min_h2`, `max_h2` were not specified, even if not calculating PBCs over one of the dimensions [#384](https://github.com/tobac-project/tobac/pull/384)

**Documentation**

- Documentation on use of `time_cell_min` in tracking added [#361](https://github.com/tobac-project/tobac/pull/361)
- Documentation on how thresholding is applied in segmentation update [#365](https://github.com/tobac-project/tobac/pull/365)
- References to tobac papers updated [#365](https://github.com/tobac-project/tobac/pull/365)

**Internal Enhancements**

- Type hints added for feature detection [#337](https://github.com/tobac-project/tobac/pull/337)
- Reorganisation and addition of type hints to interal utils [#241](https://github.com/tobac-project/tobac/pull/241)
- Type hints added for segmentation [#351](https://github.com/tobac-project/tobac/pull/351)

**Repository Enhancements**

- Matrix CI testing added for multiple python versions on Linux, MacOS and Windows [#353](https://github.com/tobac-project/tobac/pull/353)
- Issue templates with checklists added [#358](https://github.com/tobac-project/tobac/pull/358)
- Black reformatting updated to say what is wrong [#362](https://github.com/tobac-project/tobac/pull/362)
- Pylint CI workflow added to assess code quality and compare to base branch [#373](https://github.com/tobac-project/tobac/pull/373)


_**Version 1.5.1:**_

**Bug fixes**
Expand Down Expand Up @@ -73,7 +108,7 @@ _**Version 1.5.0:**_
_**Version 1.4.2:**_


**Bug fix**
**Bug fixes**

- Fixed a bug in the segmentation procedure that assigned the wrong grid cell areas to features in data frame [#246](https://github.com/tobac-project/tobac/pull/246)

Expand Down
113 changes: 54 additions & 59 deletions doc/bulk_statistics/notebooks/compute_statistics_during_feature_detection.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@
"execution_count": 1,
"metadata": {
"execution": {
"iopub.execute_input": "2023-11-22T21:24:25.784126Z",
"iopub.status.busy": "2023-11-22T21:24:25.783038Z",
"iopub.status.idle": "2023-11-22T21:24:28.947172Z",
"shell.execute_reply": "2023-11-22T21:24:28.945998Z"
"iopub.execute_input": "2023-12-08T17:03:57.177787Z",
"iopub.status.busy": "2023-12-08T17:03:57.177008Z",
"iopub.status.idle": "2023-12-08T17:03:59.275036Z",
"shell.execute_reply": "2023-12-08T17:03:59.274372Z"
}
},
"outputs": [],
Expand All @@ -42,18 +42,18 @@
"execution_count": 2,
"metadata": {
"execution": {
"iopub.execute_input": "2023-11-22T21:24:28.955365Z",
"iopub.status.busy": "2023-11-22T21:24:28.953404Z",
"iopub.status.idle": "2023-11-22T21:24:30.627015Z",
"shell.execute_reply": "2023-11-22T21:24:30.623829Z"
"iopub.execute_input": "2023-12-08T17:03:59.279994Z",
"iopub.status.busy": "2023-12-08T17:03:59.279536Z",
"iopub.status.idle": "2023-12-08T17:04:01.236248Z",
"shell.execute_reply": "2023-12-08T17:04:01.235156Z"
}
},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"using tobac version 1.5.1\n"
"using tobac version 1.5.2\n"
]
}
],
Expand All @@ -68,10 +68,10 @@
"execution_count": 3,
"metadata": {
"execution": {
"iopub.execute_input": "2023-11-22T21:24:30.635471Z",
"iopub.status.busy": "2023-11-22T21:24:30.635206Z",
"iopub.status.idle": "2023-11-22T21:24:30.640901Z",
"shell.execute_reply": "2023-11-22T21:24:30.639954Z"
"iopub.execute_input": "2023-12-08T17:04:01.275906Z",
"iopub.status.busy": "2023-12-08T17:04:01.275630Z",
"iopub.status.idle": "2023-12-08T17:04:01.279880Z",
"shell.execute_reply": "2023-12-08T17:04:01.279229Z"
}
},
"outputs": [],
Expand All @@ -98,10 +98,10 @@
"execution_count": 4,
"metadata": {
"execution": {
"iopub.execute_input": "2023-11-22T21:24:30.645377Z",
"iopub.status.busy": "2023-11-22T21:24:30.645131Z",
"iopub.status.idle": "2023-11-22T21:24:30.649660Z",
"shell.execute_reply": "2023-11-22T21:24:30.647983Z"
"iopub.execute_input": "2023-12-08T17:04:01.283135Z",
"iopub.status.busy": "2023-12-08T17:04:01.282875Z",
"iopub.status.idle": "2023-12-08T17:04:01.285964Z",
"shell.execute_reply": "2023-12-08T17:04:01.285331Z"
}
},
"outputs": [],
Expand All @@ -114,10 +114,10 @@
"execution_count": 5,
"metadata": {
"execution": {
"iopub.execute_input": "2023-11-22T21:24:30.653243Z",
"iopub.status.busy": "2023-11-22T21:24:30.652893Z",
"iopub.status.idle": "2023-11-22T21:24:30.660492Z",
"shell.execute_reply": "2023-11-22T21:24:30.657555Z"
"iopub.execute_input": "2023-12-08T17:04:01.288992Z",
"iopub.status.busy": "2023-12-08T17:04:01.288748Z",
"iopub.status.idle": "2023-12-08T17:04:01.294791Z",
"shell.execute_reply": "2023-12-08T17:04:01.293628Z"
}
},
"outputs": [],
Expand Down Expand Up @@ -149,10 +149,10 @@
"execution_count": 6,
"metadata": {
"execution": {
"iopub.execute_input": "2023-11-22T21:24:30.664194Z",
"iopub.status.busy": "2023-11-22T21:24:30.663560Z",
"iopub.status.idle": "2023-11-22T21:24:30.755221Z",
"shell.execute_reply": "2023-11-22T21:24:30.754342Z"
"iopub.execute_input": "2023-12-08T17:04:01.298020Z",
"iopub.status.busy": "2023-12-08T17:04:01.297761Z",
"iopub.status.idle": "2023-12-08T17:04:01.360190Z",
"shell.execute_reply": "2023-12-08T17:04:01.359276Z"
}
},
"outputs": [],
Expand All @@ -165,10 +165,10 @@
"execution_count": 7,
"metadata": {
"execution": {
"iopub.execute_input": "2023-11-22T21:24:30.760639Z",
"iopub.status.busy": "2023-11-22T21:24:30.760033Z",
"iopub.status.idle": "2023-11-22T21:24:30.797997Z",
"shell.execute_reply": "2023-11-22T21:24:30.795937Z"
"iopub.execute_input": "2023-12-08T17:04:01.364595Z",
"iopub.status.busy": "2023-12-08T17:04:01.364349Z",
"iopub.status.idle": "2023-12-08T17:04:01.385880Z",
"shell.execute_reply": "2023-12-08T17:04:01.385292Z"
}
},
"outputs": [
Expand Down Expand Up @@ -223,7 +223,7 @@
" margin-top: 7px;\n",
" }\n",
"</style>\n",
"<table class=\"iris\" id=\"5093423696\">\n",
"<table class=\"iris\" id=\"4932049424\">\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",
Expand Down Expand Up @@ -329,10 +329,10 @@
"execution_count": 8,
"metadata": {
"execution": {
"iopub.execute_input": "2023-11-22T21:24:30.802464Z",
"iopub.status.busy": "2023-11-22T21:24:30.802233Z",
"iopub.status.idle": "2023-11-22T21:24:30.807735Z",
"shell.execute_reply": "2023-11-22T21:24:30.806866Z"
"iopub.execute_input": "2023-12-08T17:04:01.389087Z",
"iopub.status.busy": "2023-12-08T17:04:01.388843Z",
"iopub.status.idle": "2023-12-08T17:04:01.392491Z",
"shell.execute_reply": "2023-12-08T17:04:01.391806Z"
}
},
"outputs": [],
Expand Down Expand Up @@ -368,10 +368,10 @@
"execution_count": 9,
"metadata": {
"execution": {
"iopub.execute_input": "2023-11-22T21:24:30.815250Z",
"iopub.status.busy": "2023-11-22T21:24:30.814464Z",
"iopub.status.idle": "2023-11-22T21:24:31.172956Z",
"shell.execute_reply": "2023-11-22T21:24:31.171587Z"
"iopub.execute_input": "2023-12-08T17:04:01.395680Z",
"iopub.status.busy": "2023-12-08T17:04:01.395427Z",
"iopub.status.idle": "2023-12-08T17:04:01.649955Z",
"shell.execute_reply": "2023-12-08T17:04:01.649068Z"
}
},
"outputs": [],
Expand Down Expand Up @@ -408,10 +408,10 @@
"execution_count": 10,
"metadata": {
"execution": {
"iopub.execute_input": "2023-11-22T21:24:31.178421Z",
"iopub.status.busy": "2023-11-22T21:24:31.178098Z",
"iopub.status.idle": "2023-11-22T21:24:31.185823Z",
"shell.execute_reply": "2023-11-22T21:24:31.184976Z"
"iopub.execute_input": "2023-12-08T17:04:01.661049Z",
"iopub.status.busy": "2023-12-08T17:04:01.653617Z",
"iopub.status.idle": "2023-12-08T17:04:01.665523Z",
"shell.execute_reply": "2023-12-08T17:04:01.664504Z"
}
},
"outputs": [],
Expand All @@ -434,10 +434,10 @@
"execution_count": 11,
"metadata": {
"execution": {
"iopub.execute_input": "2023-11-22T21:24:31.195121Z",
"iopub.status.busy": "2023-11-22T21:24:31.193021Z",
"iopub.status.idle": "2023-11-22T21:24:31.200453Z",
"shell.execute_reply": "2023-11-22T21:24:31.199744Z"
"iopub.execute_input": "2023-12-08T17:04:01.668749Z",
"iopub.status.busy": "2023-12-08T17:04:01.668495Z",
"iopub.status.idle": "2023-12-08T17:04:01.680223Z",
"shell.execute_reply": "2023-12-08T17:04:01.677359Z"
}
},
"outputs": [],
Expand All @@ -450,10 +450,10 @@
"execution_count": 12,
"metadata": {
"execution": {
"iopub.execute_input": "2023-11-22T21:24:31.203865Z",
"iopub.status.busy": "2023-11-22T21:24:31.203495Z",
"iopub.status.idle": "2023-11-22T21:24:54.212942Z",
"shell.execute_reply": "2023-11-22T21:24:54.212133Z"
"iopub.execute_input": "2023-12-08T17:04:01.685277Z",
"iopub.status.busy": "2023-12-08T17:04:01.684720Z",
"iopub.status.idle": "2023-12-08T17:04:20.608726Z",
"shell.execute_reply": "2023-12-08T17:04:20.608108Z"
}
},
"outputs": [
Expand Down Expand Up @@ -488,10 +488,10 @@
"execution_count": 13,
"metadata": {
"execution": {
"iopub.execute_input": "2023-11-22T21:24:54.217232Z",
"iopub.status.busy": "2023-11-22T21:24:54.216952Z",
"iopub.status.idle": "2023-11-22T21:24:54.240498Z",
"shell.execute_reply": "2023-11-22T21:24:54.239787Z"
"iopub.execute_input": "2023-12-08T17:04:20.611724Z",
"iopub.status.busy": "2023-12-08T17:04:20.611476Z",
"iopub.status.idle": "2023-12-08T17:04:20.631677Z",
"shell.execute_reply": "2023-12-08T17:04:20.631075Z"
}
},
"outputs": [
Expand Down Expand Up @@ -722,11 +722,6 @@
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
Expand Down
Loading
Loading