Skip to content

Change log#

0.8.0 (2025-09-06)#

Feat#

  • plot: add to_xyz method and improve plotting integration with Cleopatra
  • docker: add Docker support with workflow and documentation

CI#

  • docker: fix docker-release workflow configuration

Docs#

  • update badges and improve formatting in README and index files
  • fix typo in dev container setup steps
  • migrate to MkDocs with Google-style docstrings and diagrams

Chore#

  • deps: disable changelog autoupdate - Disabled update_changelog_on_bump in pyproject settings - Updated styles in pyproject for improved terminal prompts - Simplified release workflow by removing unnecessary debug steps
  • release: enhance debug visibility and tag handling in workflow
  • release: ensure tags are fetched for release workflow
  • deps: update sha256 checksum for pyramids-gis to match new version 0.7.3
  • pyproject: remove major_version_zero configuration
  • release: add Commitizen and automated release workflow
  • update dependencies, workflows, and docs
  • dev: add dev container and docs
  • ci: update workflow permissions and group publishing dependencies

0.7.3 (2025-08-02)#

Dev#

  • add pixi configuration to the pyproject.toml file.
  • relax the limits for the dependencies in the pyproject.toml file.
  • gdal is installed from conda-forge channel.
  • update the workflow to use the new pixi configuration.

0.7.2 (2025-01-12)#

Dev#

  • replace the setup.py with pyproject.toml
  • automatic search for the gdal_plugins_path in the conda environment, and setting the GDAL_DRIVER_PATH environment variable.
  • add python 3.12 to CI.

0.7.1 (2024-12-07)#

  • update cleopatra package version to 0.5.1 and update the api to use the new version.
  • update the miniconda workflow in ci.
  • update gdal to 3.10 and update the DataSource to Dataset in the FeatureCollection.file_name.
  • add libgdal-netcdf and libgdal-hdf4 to the conda dependencies.

0.7.0 (2024-06-01)#

  • install viz, dev, all packages through pip.
  • create a separate module for the netcdf files.
  • add configuration file and module for setting gdal configurations.

AbstractDataset#

  • add meta_data property to return the metadata of the dataset.
  • add access property to indicate the access mode of the dataset.

Dataset#

  • add extra parameter file_i to the read_file method to read a specific file in a compressed file.
  • initialize the GDAL_TIFF_INTERNAL_MASK configuration to No
  • the add the access parameter to the constructor to set the access mode of the dataset.
  • add the band_units property to return the units of the bands.
  • the __str__ and the __repr__ methods return string numpy like data type (instead of the gdal constant) of the dataset.
  • add meta_data property setter to set any key:value as a metadata of the dataset.
  • add scale and offset properties to set the scale and offset of the bands.
  • add copy method to copy the dataset to memory.
  • add get_attribute_tableset_attribute_table` method to get/set the attribute table of a specific band.
  • the plot method uses the rgb bands defined in the dataset plotting (if exist).
  • add create method to create a new dataset from scratch.
  • add write_array method to write an array to an existing dataset.
  • add get_mask method to get the mask of a dataset band.
  • add band_color method to get the color assigned to a specific band (RGB).
  • add get_band_by_color method to get the band index by its color.
  • add get_histogram method to get/calculate the histogram of a specific band.
  • the read_array method takes and extra parameter window to lazily read a window of the raster, the window is [xoff, yoff, x-window, y-window], the window can also be a geodataframe.
  • add get_block_arrangement method divide the raster into tiles based on the block size.
  • add tiff file writing options (compression/tile/tile_length)
  • add close method to flush to desk and close a dataset.
  • add add_band method to add an array as a band to an existing dataset.
  • rename pivot_point to top_left_corner in the create method.
  • the to_file method return a Dataset object pointing to the saved dataset rather than the need to re-read the saved dataset after you save it.

Datacube#

  • the Datacube is moved to a separate module datacube.

NetCDF#

  • move all the netcdf related functions to a separate module netcdf.

FeatureCollection#

  • rename the pivot_point to top_left_corner

Deprecated#

*Cropping a raster using a polygon is done now directly using gdal.wrap nand the the _crop_with_polygon_by_rasterizing is deprecated. * rename the interpolation method nearest neighbour to nearest neighbor.

0.6.0 (2024-02-24)#

  • move the dem module to a separate package "digital-rivers".

0.5.6 (2024-01-09)#

Dataset#

  • create create_overviews, recreate_overview, read_overview_array methods, and overview_count attribute to handle overviews.
  • The plot method takes an extra parameters overviews and overview_index to enable plotting overviews instead of the real values in the bands.

0.5.5 (2024-01-04)#

Dataset#

  • Count domain cells for a specific band.

0.5.4 (2023-12-31)#

Dataset#

  • fix the un-updated array dimension bug in the crop method when the mask is a vector mask and the touch parameter is True.

0.5.3 (2023-12-28)#

Dataset#

  • Introduce a new parameter touch to the crop method in the Dataset to enable considering the cells that most of the cell lies inside the mask, not only the cells that lie entirely inside the mask.
  • Introduce a new parameter inplace to the crop method in the Dataset to enable replacing the dataset object with the new cropped dataset.
  • Adjust the stats method to take a mask to calculate the stats inside this mask.

0.5.2 (2023-12-27)#

Dataset#

  • add _iloc method to get the gdal band object by index.
  • add stats method to calculate the statistics of the raster bands.

0.5.1 (2023-11-27)#

Dataset#

  • revert the convert_longitude method to not use the gdal_wrap method as it is not working with the new version of gdal (newer tan 3.7.1).
  • bump up versions.

0.5.0 (2023-10-01)#

Dataset#

  • The dtype attribute is not initialized in the init, but initialized when using the dtype property.
  • Create band_names setter method.
  • add gdal_dtype, numpy_dtype, and dtype attribute to change between the dtype (data type general name), and the corresponding data type in numpy and gdal.
  • Create color_table attribute, getter & setter property to set a symbology (assign color to different values in each band).
  • The read_array method returns array with the same type as the dtype of the first band in the raster.
  • add a setter method to the band_names property.
  • The methods (create_driver_from_scratch, get_band_names) is converted to private method.
  • The no_data_value check the dtype before setting any value.
  • The convert_longitude used the gdal.Wrap method instead of making the calculation step by step.
  • The to_polygon is converted to _band_to_polygon private method used in the clusters method.
  • The to_geodataframe is converted to to_feature_collection. change the backend of the function to use the crop function is a vector mask is given.
  • the to_crs takes an extra parameter "inplace".
  • The locate_points is converted to map_to_array_coordinates.
  • Create array_to_map_coordinates to translate the array indices into real map coordinates.

DataCube#

  • rename the read_separate_files to read_multiple_files, and enable it to use regex strings to filter files in a given directory.
  • rename read_dataset to open_datacube.
  • rename the data attribute to values

FeatureCollection#

  • Add a pivot_point attribute to return the top left corner/first coordinates of the polygon.
  • Add a layers_count property to return the number of layers in the file.
  • Add a layer_names property to return the layers names.
  • Add a column property to return column names.
  • Add the file_name property to store the file name.
  • Add the dtypes property to retrieve the data types of the columns in the file.
  • Rename bounds to total_bounds.
  • The _gdf_to_ds can convert the GeoDataFrame to a ogr.DataSource and to a gdal.Dataset.
  • The create_point method returns a shapely point object or a GeoDataFrame if an epsg number is given.

0.4.2 (2023-04-27)#

  • fix bug in plotting dataset without specifying the band
  • fix bug in passing ot not passing band index in case of multi band rasters
  • change the bounds in to_dataset method to total_bounds tp get the bbox of the whole geometries in the gdf
  • add convert_longitude method to convert longitude to range between -180 and 180

0.4.1 (2023-04-23)#

  • adjust all spatial operation functions to work with multi-band rasters.
  • use gdal exceptions to capture runtime error of not finding the the file.
  • add cluster method to dataset class.
  • time_stamp attribute returns None if there is no time_stamp.
  • restructure the no_data_value related functions.
  • plot function can plot rgb image for multi-band rasters.
  • to_file detect the driver type from the extension in the path.

0.4.0 (2023-04-11)#

  • Restructure the whole package to two main objects Dataset and FeatureCollection
  • Add class for multiple Dataset "DataCube".
  • Link both Dataset and FeatureCollection to convert between raster and vector data types.
  • Remove rasterio and netcdf from dependencies and depend only on gdal.
  • Test read rasters/netcdf from virtual file systems (aws, compressed)
  • Add dunder methods for all classes.
  • add plotting functionality and cleopatra (plotting package) as an optional package.
  • remove loops and replace it with ufunc from numpy.

0.3.3 (2023-02-06)#

  • fix bug in reading the ogr drivers catalog for the vector class
  • fix bug in creating rasterLike in the asciiToRaster method

0.3.2 (2023-01-29)#

  • refactor code
  • add documentation
  • fix creating memory driver with compression in _createDataset

0.3.1 (2023-01-25)#

  • add pyarrow to use parquet data type for saving dataframes and geodataframes
  • add H3 indexing package, and add new module indexing with functions to convert geometries to indices back and forth.
  • fix bug in calculating pivot point of the netcdf file
  • rasterToDataFrame function will create geometries of the cells only based on the add_geometry parameter.

0.3.0 (2023-01-23)#

  • add array module to deal with any array operations.
  • add openDataset, getEPSG create SpatialReference, and setNoDataValue utility function, getCellCoords, ...
  • add rasterToPolygon, PolygonToRaster, rasterToGeoDataFrame, conversion between ogr DataSource and GeoDataFrame.

0.2.11 (2023-01-14)#

  • add utils module for functions dealing with compressing files, and others utility functions

0.2.11 (2022-12-27)#

  • fix bug in pypi package names in requirements.txt file

0.2.10 (2022-12-25)#

  • lock numpy version to 1.23.5 as conda-forge can not install 1.24.0

0.2.9 (2022-12-19)#

  • Use environment.yaml and requirements.txt instead of pyproject.toml and replace poetry env by conda env

0.1.0 (2022-05-24)#

  • First release on PyPI.