add pip ionstall matplotlib to tutorial notebooks

Author: Laurent Thomas

CHANGELOG.md

@@ -3,17 +3,27 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).  
 
-### [1.6.4] - 2023-03-03
+
+## [1.6.5] - 2023-06-12
+
+### Changed
+- Throw a clearer error message in place of OpenCV error message when template and/or image has 0-width or height
+- Add `pip install matplotlib` in example notebooks since not an actualy dependency of MTM
+
+
+## [1.6.4] - 2023-03-03
 
 ### Changed 
 - Improve speed by adding concurrency in the findMatches method, using half the number of cpu cores available.
 - Mention installation in editable mode in README
 
-### [1.6.3] - 2021-11-24  
+
+## [1.6.3] - 2021-11-24  
 
 ### Changed 
 - Updated internal NMS code to work with latest OpenCV, and set min OpenCV version to 4.5.4.   
 
+
 ## [1.6.2.post1] - 2021-11-24  
 
 ### Changed

MTM/version.py

@@ -2,4 +2,4 @@
 # 1) we don't load dependencies by storing it in __init__.py
 # 2) we can import it in setup.py for the same reason
 # 3) we can import it into your module module
-__version__ = '1.6.4'
+__version__ = '1.6.5'

tutorials/Benchmark.ipynb

@@ -41,10 +41,22 @@
     }
    ],
    "source": [
-    "# Go to root folder of the repo\n",
+    "# Set the root of the repo as the working directory, when running the notebook locally to load the package locally too\n",
+    "# Not needed if the package was installed with pip\n",
     "%cd .."
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Install matplotlib if not already installed\n",
+    "# it is used in this notebook, but is otherwise not an actual dependency of MTM\n",
+    "%pip install matplotlib"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 5,
@@ -766,7 +778,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -780,7 +792,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.3"
+   "version": "3.8.10"
   }
  },
  "nbformat": 4,

tutorials/InteractiveParameters.ipynb

@@ -22,10 +22,22 @@
     }
    ],
    "source": [
-    "# If using local source code, set working directory to repo directory\n",
+    "# Set the root of the repo as the working directory, when running the notebook locally to load the package locally too\n",
+    "# Not needed if the package was installed with pip\n",
     "%cd .."
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Install matplotlib if not already installed\n",
+    "# it is used in this notebook, but is otherwise not an actual dependency of MTM\n",
+    "%pip install matplotlib"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 2,
@@ -2646,7 +2658,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -2660,7 +2672,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.3"
+   "version": "3.8.10"
   }
  },
  "nbformat": 4,

tutorials/NoiseBenchmark.ipynb

@@ -10,6 +10,17 @@
     "Only for the second detection we introduce some random noise in the image."
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Install matplotlib if not already installed\n",
+    "# it is used in this notebook, but is otherwise not an actual dependency of MTM\n",
+    "%pip install matplotlib"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 1,
@@ -349,7 +360,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -363,7 +374,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.6.6"
+   "version": "3.8.10"
   }
  },
  "nbformat": 4,

tutorials/Tutorial1-Introduction.ipynb

@@ -38,12 +38,25 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "C:\\Users\\Laurent Thomas\\Documents\\repo-MTM-Python\n"
+      "C:\\Users\\Laurent.Thomas\\Documents\\GitHub\\MultiTemplateMatching-Python\n"
      ]
     }
    ],
    "source": [
-    "cd .."
+    "# Set the root of the repo as the working directory, when running the notebook locally to load the package locally too\n",
+    "# Not needed if the package was installed with pip\n",
+    "%cd .."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Install matplotlib if not already installed\n",
+    "# it is used in this notebook, but is otherwise not an actual dependency of MTM\n",
+    "%pip install matplotlib"
    ]
   },
   {
@@ -55,7 +68,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "MTM version:  1.6.0\n"
+      "MTM version:  1.6.4\n"
      ]
     }
    ],
@@ -601,7 +614,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -615,7 +628,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.3"
+   "version": "3.8.10"
   }
  },
  "nbformat": 4,

tutorials/Tutorial2-Template_Augmentation.ipynb

@@ -29,19 +29,32 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 2,
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "C:\\Users\\Laurent Thomas\\Documents\n"
+      "C:\\Users\\Laurent.Thomas\\Documents\\GitHub\\MultiTemplateMatching-Python\n"
      ]
     }
    ],
    "source": [
-    "cd .."
+    "# Set the root of the repo as the working directory, when running the notebook locally to load the package locally too\n",
+    "# Not needed if the package was installed with pip\n",
+    "%cd .."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Install matplotlib if not already installed\n",
+    "# it is used in this notebook, but is otherwise not an actual dependency of MTM\n",
+    "%pip install matplotlib"
    ]
   },
   {
@@ -484,7 +497,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -498,7 +511,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.3"
+   "version": "3.8.10"
   }
  },
  "nbformat": 4,

tutorials/Tutorial3-SpeedingUp.ipynb

@@ -36,7 +36,20 @@
     }
    ],
    "source": [
-    "cd .."
+    "# Set the root of the repo as the working directory, when running the notebook locally to load the package locally too\n",
+    "# Not needed if the package was installed with pip\n",
+    "%cd .."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Install matplotlib if not already installed\n",
+    "# it is used in this notebook, but is otherwise not an actual dependency of MTM\n",
+    "%pip install matplotlib"
    ]
   },
   {
@@ -703,7 +716,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -717,7 +730,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.3"
+   "version": "3.8.10"
   }
  },
  "nbformat": 4,