Add docstrings and refactor code

GeostatsGuy / GeostatsPy

GeostatsPy Python package for spatial data analytics and geostatistics. Started as a reimplementation of GSLIB, Geostatistical Library (Deutsch and Journel, 1992) from Fortran to Python, Geostatistics in a Python package. Now with many additional methods. I hope this resources is helpful, Prof. Michael Pyrcz

https://pypi.org/project/geostatspy/

MIT License

479 stars 183 forks source link

Add docstrings and refactor code #2

Closed qpenko closed 5 years ago

qpenko commented 5 years ago

This is an attempt to:

Add docstrings to every function. Existing code comments and online resources were used to obtain function and parameters description
Refactor code to comply with PEP8 where possible
Update code for some routines to make it consistent across the package
Fix bugs, remove unused variables and duplicated functions

Areas that need additional attention were marked with "TODO" comment:

Docstring parameters without description
Unused variables
Unknown function

GeostatsGuy commented 5 years ago

Appreciation to Anton Kupenko for this great assistance on the package. Looking forward to working together on this package. I will add missing parameter descriptions in the next week. I'm almost done with sequential Gaussian simulation. Michael