Merge pull request #79 from tmillenaar/release_0.10.0

Add release notes for 0.10.0

Author: tmillenaar

docs/source/release_notes.rst

@@ -3,6 +3,21 @@
 Release notes
 ================
 
+
+Version 0.10.0 (April 21, 2024)
+------------------------------
+Features
+ - Add :meth:`.GridIndex.sort`
+ - Allow plotting of RGB(A) values in :func:`.doc_utils.plot_polygons`
+ - Improve performance of :func:`.doc_utils.plot_polygons`
+ - Improve performance of initializing a new :class:`.GridIndex` if the supplied indices are already in an appropriate numpy integer ndarray.
+
+Fixes
+ - Fix incorrect :meth:`.HexGrid.relative_neighbours` and by extension :meth:`.BaseGrid.neighbours` for :class:`.HexGrid` when supplying multiple grid indices at a time
+
+Documentation
+ - Add example :ref:`2d_diff_hex_anim.py <example diffusion>`
+
 Version 0.9.2 (April 03, 2024)
 ------------------------------
 Features

gridkit/index.py

@@ -222,6 +222,29 @@ def unique(self, **kwargs):
         return GridIndex.from_index_1d(unique)
 
     def sort(self):
+        """Sort the grid indices. Multidimentional indices are not supported.
+        Ravels the indices if indices are multidimentional.
+
+        The indices are sorted first by x, then by y.
+
+        Returns
+        -------
+        :class:`.GridIndex`
+            The sorted ids
+
+        Examples
+        --------
+
+        >>> from gridkit.index import GridIndex
+        >>> unsorted_ids = GridIndex([[1,1],[0,1],[1,0],[0,0]])
+        >>> sorted_ids = unsorted_ids.sort()
+        >>> sorted_ids.index
+        array([[0, 0],
+               [0, 1],
+               [1, 0],
+               [1, 1]], dtype=int32)
+
+        """
         return GridIndex.from_index_1d(numpy.sort(self.index_1d))
 
     def intersection(self, other):