gempy icon indicating copy to clipboard operation
gempy copied to clipboard

[WIP] Documentation and robustification of Kriging for spacial interpolation

Open TobiasGlaubach opened this issue 4 years ago • 5 comments

Description

1.) Added documentation in docstrings 2.) replaced prints for errors with actual exceptions 3.) implemented a scheme where the equation system can be solved either by QR decomposition or least square minimzation or 'smart' by calculating the rank first. Implemented a default parameter so that the original impleentation is conserved.

Checklist

  • [x] My code follows the PEP 8 style guidelines.
  • [x] My code uses type hinting for function and method arguments and return values.
  • [x] My code contains descriptive and helpful docstrings which are formatted per the [Google Python Style Guidelines] (http://google.github.io/styleguide/pyguide.html). --> used standard Pycharm doc string format
  • [ ] I have created tests which entirely cover my code.
  • [ ] The test code either 1. demonstrates at least one valuable use case (e.g. integration tests) or 2. verifies that outputs are as expected for given inputs (e.g. unit tests).
  • [ ] New and existing tests pass locally with my changes.

TobiasGlaubach avatar Apr 03 '20 16:04 TobiasGlaubach

Hello @TobiasGlaubach ,

thanks a lot for this - I wrote this during my first coding steps and it needed this polishing (and probably needs some more). I will take this pull request as a chance to write some tests to cover the code - just so you don't wonder that it takes a while.

Thanks again, best wishes and stay healthy!

javoha avatar Apr 07 '20 07:04 javoha

Can you merge this branch with master to fix travis

Leguark avatar Apr 07 '20 09:04 Leguark

I've tagged the PR as a WIP as long as this is being worked on. Let me know when / if you need review! 🤙

alex-schaaf avatar Apr 09 '20 08:04 alex-schaaf

This is pending adding tests or am I mistaken @javoha ? (no rush though)

Leguark avatar Apr 15 '20 14:04 Leguark

This is pending adding tests or am I mistaken @javoha ? (no rush though)

Yes, might take me a bit though with the semester starting.

javoha avatar Apr 15 '20 14:04 javoha

hopefully, we will come back to this soon but for now we close it

Leguark avatar Apr 16 '24 11:04 Leguark