pdgruby / geokrige Goto Github PK

For comprehensive documentation, please visit the readthedocs webpage.

GeoKrige is a Python package designed for spatial interpolation using Kriging Methods. While primarily tailored for geospatial analysis, it is equally applicable to other spatial analysis tasks.

GeoKrige simplifies kriging interpolation, offering an intuitive interface akin to the SciKit-learn package.

• Seamless integration with the GeoPandas and rasterio packages
• Generation of interpolated mesh grids aligned with the boundaries of provided shapefiles (ideal for creating interpolation maps)
• Evaluation tool for created kriging models
• Support for multidimensional interpolation (Multidimensional Kriging)
• Several default variogram models, flexibility for users to define custom models

There are few topics to which you can contribute:

• implementing the Universal Kriging method
• creating unit tests
• designing a cool-looking logo :)

If you have other ideas on how to improve the package, feel free to share them in the Ideas sction

When writing a commit message, please adhere to the guidelines outlined in this tutorial.

The commit message template:

• [<type>/...] <commit message>

The commit types are described in the linked tutorial, but try to adhere to: feat, bugfix, docs, refact, test, other. If a specific commit pertains to multiple types, separate them with / and ensure they are ordered alphabetically. Keep the commit message title brief and descriptive. If a longer description is necessary, please use the second -m option.

Exemplary commit messages:

• [bugfix] Fix the 'evaluate' method

• [docs/refact] Change the 'KrigingBase' class attributes & adjust the documentation to these changes

Please, use the Q&A section in case you need a help.