Add normal gravitation method to Sphere

fatiando / boule

Reference ellipsoids for geodesy and geophysics

https://www.fatiando.org/boule

BSD 3-Clause "New" or "Revised" License

38 stars 17 forks source link

Add normal gravitation method to Sphere #73

Closed dabiged closed 2 years ago

dabiged commented 3 years ago

This includes the si_units flag as discusses in #69. Fixes #54

Reminders:

[x] Run make format and make check to make sure the code follows the style guide.
[ ] Add tests for new features or tests that would have caught the bug that you're fixing.
[ ] Add new public functions/methods/classes to doc/api/index.rst and the base __init__.py file for the package.
[x] Write detailed docstrings for all functions/classes/methods. It often helps to design better code if you write the docstrings first.
[x] If adding new functionality, add an example to the docstring, gallery, and/or tutorials.
[ ] Add your full name, affiliation, and ORCID (optional) to the AUTHORS.md file (if you haven't already) in case you'd like to be listed as an author on the Zenodo archive of the next release.

leouieda commented 3 years ago

I edited your PR description a bit. If you use the keyword Fixes, GitHub will automatically close the issue when this PR is merged.

dabiged commented 3 years ago

Can someone explain what the automated check here is complaining about? I don't know how to fix this.

leouieda commented 3 years ago

Can someone explain what the automated check here is complaining about? I don't know how to fix this.

It's complaining that only 66% percent of your changes are executed during testing. This means that some parts of the code are never executed by the tests. Run the tests locally and you will see exactly which lines don't get executed as part of the test results. This is probably the if statement for SI units. Take a look at boule/tests for examples of test functions.

leouieda commented 2 years ago

@dabiged thanks for getting this started and sorry that it was stalled for so long! To push this through, I made a small fix to the docstring formatting and added a quick doctest to make sure everything was covered. Merging it in as soon as CIs all pass.

leouieda commented 2 years ago

Ignoring the pylint failure since we're moving away from it soon anyway.