Release notes

Version 0.14.1 (December 25, 2024)

Features

• Add arguments location and adjust_rotation to TriGrid.to_crs(), RectGrid.to_crs() and HexGrid.to_crs() for more accurate conversions.

Misc

• Build using python3.9 because for 3.8 the geopandas/fiona documentation dependency installs incompatible versions

Version 0.14.0 (August 11, 2024)

Featrures

• A new Tile class that references a set of cells and has some convenience methods that describe the tile, such as Tile.indices and Tile.corners. This class is takes a similar role to the BaseGrid.cells_in_bounds() method, but is able to work with rotated grids. The intent is that in the long run a DataTile will replace the BoundedGrid for this reason.

Documentation

• Add example tiles.py which explains the usage of the new Tile class.

• Use more neighbours in example flower_of_life.py since the final flower was missing some circles in the bottom left.

Misc

• Rename the PyO3 classes PyTriGrid, PyRectGrid and PyHexGrid to PyO3TriGrid, PyO3RectGrid and PyO3HexGrid, respectively. This is done to avoid confusion. From the Rust perspective these represent Python classes but from the Python perspective these represent Rust classes. PyO3 seems to be less ambiguous for it makes sense from both perspectives.

Version 0.13.0 (July 10, 2024)

Features

• Option to initialize grid using side_length instead of size or area

Fixes

• Comparisson operators for GridIndex now also work when comparing to non-grid index classes. For example GridIndex([1,2]) == (1,2) will result in True. By extension, (1,2) in GridIndex([[1,2], [0,0]]) now also works as expected.

Documentation

• Add example flower_of_life.py

Version 0.12.1 (Jun 17, 2024)

Misc

• Make compatible with numpy v2.0.0 while remaining compatible with earlier versions

Version 0.12.0 (May 10, 2024)

Featrures

• Create a new grid with a smaller gridsize that fits perfectily inside the orignal grid using TriGrid.subdivide(), RectGrid.subdivide() or HexGrid.subdivide()

Documentation

• Add tip to triangles_in_hexes.py hinting to the use of the new subdivide and anchor methods.

Version 0.11.1 (June 01, 2024)

Features

• Add method anchor to Bounded Grids (grids with data) that resamples the data after shifting, see BoundedTriGrid.anchor(), BoundedRectGrid.anchor() and BoundedHexGrid.anchor()

• Shift nearby corner to specified location using cell_element="corner" in BaseGrid.anchor() and their bounded equavalents mentioned above

• Add an easy method to access all important paramers defining the grid: BaseGrid.definition()

Version 0.11.0 (May 29, 2024)

Features

• Easier shifting of grids using BaseGrid.anchor()

Fixes

• Fix issue in HexGrid where offsets were incorrectly applied when the supplied offsets were not between 0:cell size

• Fix ‘flat’ HexGrids rotating in the other direction

• Fix error regarding the datatype when supplying the offset for a TriGrid as a non-tuple iterable such as a list or numpy array

• Fix HexGrid.cell_at_point() not properly taking x-offset into account

• Fix issue where the offset would flip for ‘flat’ HexGrids when using the offset setter but not when calling grid.update(offset=new_offset)

Documentation

• Simplify centering of grids in examples selecting_cells.py, rotation_animation.py and rotation_animation.py

Deprecations

• ‘flat’ shape for HexGrid will be deprecated in favor of rotation in v1.0.0. A warning will be raised on class initiation.

Known Issues

• The implementation of ‘flat’ HexGrids is done by swapping the x and y axes compared to a ‘pointy’ grid. With this release, several issues related to the offset were fixed, but this implementation aspect now leaks into the offset. This means the user might specify an offset of (0,1) and expect a shift of 1 in the y-axis but the shift occurs in the x-axis. Since ‘flat’ HexGrids will be deprecated in release v1.0.0, fixing this is not worth the effort, meaning this leaky abstraction will be deliberately ignored.

Version 0.10.0 (April 21, 2024)

Features

• Add GridIndex.sort()

• Allow plotting of RGB(A) values in doc_utils.plot_polygons()

• Improve performance of doc_utils.plot_polygons()

• Improve performance of initializing a new GridIndex if the supplied indices are already in an appropriate numpy integer ndarray.

Fixes

• Fix incorrect HexGrid.relative_neighbours() and by extension BaseGrid.neighbours() for HexGrid when supplying multiple grid indices at a time

Documentation

• Add example 2d_diff_hex_anim.py

Version 0.9.2 (April 03, 2024)

Features

• Add new initialization argument area to TriGrid, RectGrid and HexGrid for specifying the cell area of the grid

• Add new property BaseGrid.area()

• Add shape to RectGrid to further unify the class API between the three grid types

Fixes

• Prevent passing rotation argument to Bounded grids, which were not designed with rotation in mind because that breaks the tiling.

Documentation

• Update example resampling.py

• Improve docstrings about initialization of TriGrid, RectGrid and HexGrid

Version 0.9.1 (March 17, 2024)

Features

• Change the following attributes using a setter: rotation, offset and (size for TriGrid and HexGrid) or (dx and dy for RectGrid)

• Add BaseGrid.cell_height() and BaseGrid.cell_width()

• Add BaseGrid.update() method for easily making small changes to grid specs

Fixes

• offset is now properly taken into account for HexGrid.cell_at_point()

• Less restrictive offsets by limiting offset for all grids with BaseGrid.cell_height() and BaseGrid.cell_width() instead of dx and dy.

• Rotation of “flat” HexGrid is no longer in the opposite direction (was clockwise)

Documentation

• Add example rotation_animation.py.

Version 0.9.0 (March 10, 2024)

Features

• Rotation for TriGrid, RectGrid and HexGrid

  • Note: not for the bounded versions

Fixes:

• Fixed RectGrid.cells_near_point() returning incorrect cells for negative points

Documentation

• Add example rotated_grids.py.

Version 0.8.0 (March 03, 2024)

Fixes

• Return GridIndex from HexGrid.cells_near_point()

• Align return shape of index RectGrid.cells_near_point() with those of TriGrid.cells_near_point() and HexGrid.cells_near_point() (!API change)

• Allow multi-dimensional input and returns form method cells_near_point on the three grid types

Misc

• Move the following methods to Rust:

  • RectGrid.cells_near_point()

  • HexGrid.cells_near_point()

Version 0.7.3 (February 25, 2024)

Fixes

• Properly handle negative offsets in Rust grid classes

Misc

• Move the following methods to Rust:

  • RectGrid.centroid()

  • RectGrid.cell_at_point()

  • RectGrid.cell_corners()

  • HexGrid.centroid()

  • HexGrid.cell_at_point()

  • HexGrid.cell_corners()

  This is done in preparation of rotation of un-bounded grids and provides a minor speedup.

Version 0.7.2 (February 18, 2024)

Features

• Replace GridIndex._1d_view with GridIndex.index_1d(), which is an int64 instead of a custom data type.

• Replace index._nd_view with GridIndex.from_index_1d()

Fixes

• Remove redundant array allocation in TriGrid.cells_in_bounds()

Documentation

• Remove dask_geopandas dependency in example aggregate_dask.py. Use GridIndex.index_1d() instead.

• Use numpy array GridIndex.index_1d() in example aggregate.py instead of a python list of GridIndex objects.

Version 0.7.1 (February 11, 2024)

Fixes

• Remove allocation of unused array

Documentation

• Add building of Rust binary to the contributing guide

Misc

• Improve performance of BaseGrid.to_shapely()

Version 0.7.0 (February 04, 2024)

Features

• Add BoundedTriGrid

• Improved performance of linear resampling for BoundedHexGrid

• “inverse_distance” interpolation method for BoundedGrid.resample() and BoundedGrid.interpolate()

Fixes

• Fixed incorrect cell returned for points in TriGrid.cell_at_point() near the cell edge

• Allow for nd input in TriGrid.cell_at_point()

Version 0.6.0 (January 07, 2024)

Features

• Add TriGrid (Only base variant, BoundedTriGrid is yet to come)

Fixes

• BaseGrid.to_shapely() now properly handles ND input

• HexGrid.relative_neighbours() now properly handles ND input

Documentation

• Add example triangles_in_hexes.py

• doc_utils.plot_polygons() used in examples now plots both lines and filled polygons

Misc

• Add Rust bindings using the maturin package

• Renamed the test rasters used in example ndvi.py because Windows failed on special characters in the name

• Put index as first argument instead of second in HexGrid.relative_neighbours()

CICD

• Retire setup.py in favour of pyproject.toml

• Build package using maturin

• Test deploy for linux, macos and windows before uploading the sdist to PyPi

Version 0.5.1 (October 08, 2023)

Fixes

• BaseGrid.to_shapely() now returns single Polygon if a single GridIndex was supplied

Documentation

• Add example aggregate_dask.py

Version 0.5.0 (October 01, 2023)

Features

• Make return argument shape optional in BaseGrid.cells_in_bounds() by adding the return_cell_shape argument (default False)

• Structure the GridIndex returned by BaseGrid.cells_in_bounds() in the shape of the grid (2D)

• Now the return shape of BaseGrid.to_shapely() is the same as the input shape of the index argument (if as_multipolygon is False)

• Allow BoundedRectGrid.centroid() to be called without specifying the index argument, use the cells in it’s bounds by default

• Better error when index is not supplied to centroid method on grids that are not bounded

Misc

• Remove placeholder methods that no longer fit the curent API

• Add tests for BaseGrid.to_shapely()

• Add tests for BaseGrid.cell_corners()

Version 0.4.8 (September 18, 2023)

Features

• Add methods RectGrid.to_bounded() and HexGrid.to_bounded() to turn an infinite grid into a bounded grid.

Version 0.4.7 (September 10, 2023)

Features

• concat() for combining GridIndex objects

Documentation

• Fixed problems related to slicing ‘flat’ BoundedHexGrid objects

• Swap formerly incorrect BoundedHexGrid.height() and BoundedHexGrid.width() for ‘flat’ BoundedHexGrid objects

• Fixed nesting issue in menu navigation

• Add colorbars to example partial_overlap.py

• Simplify example elevation_distribution_per_landcover.py

Misc

• Add basic tests for statistical functions sum(), mean()

CICD

• Allow for manual triggering of documentation pipeline

Version 0.4.6 (September 4, 2023)

Features

• Make ‘index’ argument optional in BoundedGrid.value()

Documentation

• Add example partial_overlap.py

• Update the way docs are build in the contributing guide

• Improve docstring of BoundedGrid.value()

Version 0.4.5 (August 27, 2023)

Fixes

• Replace all mentions of read_geotiff in example gallery to write_geotiff

• build docs without referencing setup.py

Misc

• Add test to verify if the documentation builds succesfully

• Add docs_require to tests_require in setup.py

• remove restriction on sphinx version

Version 0.4.4 (August 27, 2023)

Fixes

• Add missing matplotlib to docs_require

Version 0.4.3 (August 27, 2023)

Fixes

• Pin sphinx version to prevent docs build step from erroring

Version 0.4.2 (August 27, 2023)

Fixes

• Fix to_crs on HexGrid and RectGrid (only worked on bounded equivalents)

Documentation

• Improved docstrings for to_crs on BaseGrid, HexGrid, RectGrid, BoundedHexGrid and BoundedRectGrid

• Add docstrings to read_raster() and write_raster()

Misc

• Import GridIndex, validate_index(), BaseGrid, RectGrid, HexGrid, BoundedRectGrid and BoundedHexGrid as part of gridkit to make for more convenient importing (eg from gridkit import HexGrid)

• Move pytest and matplotlib requirements from requirements.txt to tests_require in setup.py

• Rename read_geotiff() to read_raster(). The former will be deprecated in a future release.

Version 0.4.1 (August 20, 2023)

Features

• make GridIndex hashable so it works as pandas index

• remove any empty axis on GridIndex initialization

Documentation

• create example script aggregate.py

• rename Shape interactions section to Vector data interactions

• create doc_utils.py to contain helper functions for plotting and input generation used in examples

Version 0.4.0 (August 13, 2023)

Features

• GridIndex class to unify index representation

• validate_index() decorator to turn any index represetntation into a GridIndex on function call

• Operations that return grid indices now return GridIndex instances instead of numpy arrays

Version 0.3.1 (July 23, 2023)

Features

• add numpy_id_to_grid_id() to BoundedHexGrid

• add grid_id_to_numpy_id() to BoundedHexGrid

Fixes

• resolve shift in data when using comparisson and mathematical operators on BoudedHexGrid

Documentation

• Add examle on coordinate transformations

Version 0.3.0 (July 16, 2023)

Features

• Resample method for BoundedHexGrid

• Bilinear interpolation method for BoundedHexGrid

• Split Interpolate method from resample method

• Codecov integration

CICD

• black and isort checks in test pipeline

Documentation

• Add missing docstrings to resample method

Misc

• reformat python files using black and isort

• move Resample method one step up in the inheritance hierarchy, to BoundedGrid

Version 0.2.0 (July 10, 2023)

Features

• Add hex_grid.HexGrid class

• Add hex_grid.BoundedHexGrid class

• to_shapely() on bounded grids returns the shapes in the bounds when no index is supplied

• add action for pytest and doctest on push

• turn bounded_grid.indices into a property

Fixes

• set proper version when documentation is build

Documentation

• build documentation when tagged instead of merged in main

• add example “Hexagon grids”

• add example “Cell selection using other grids”

• add example “Resampling”

• use hexagons instead of squares in example “Interpolate from points”

Version 0.1.1 (March 17, 2023)

Fixes

• Fix __version__` missing an ending quotation mark

Version 0.1.0 (March 17, 2023)

• release first version to PyPi