harmonica icon indicating copy to clipboard operation
harmonica copied to clipboard

Published 20 hours ago • verified publisher icon fatiando

WIP Add tutorial about normal gravity and free-air correction

Open santisoler opened this issue 3 years ago • 3 comments

Add tutorial on the use of the closed-form formula for normal gravity and a comparison with the free-air correction (first-order approximation). Modify doc configuration and index files to include the new tutorial pages.

Reminders:

  • [ ] 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.
  • [ ] Write detailed docstrings for all functions/classes/methods. It often helps to design better code if you write the docstrings first.
  • [ ] 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.

santisoler avatar Dec 22 '20 20:12 santisoler

This could be inside FAQs section instead of a tutorial. We should add a tutorial on how to compute gravity disturbance and link to this FAQ at the end with a side note on why not use free-air correction.

santisoler avatar Jan 05 '21 15:01 santisoler

I'm thinking to put the tutorial of gravity disturbance and free-air gravity like this. https://github.com/LL-Geo/PFToolbox/blob/master/Gravity%20disturbance.ipynb Keen for comments and suggestions 😄 @leouieda @santisoler

LL-Geo avatar Sep 11 '21 14:09 LL-Geo

@LL-Geo I definitely think that the tutorial about normal gravity should be something like the Notebook you wrote. While the explanation about free-air vs analytical solution for normal gravity should be something like a FAQ. So feel free to use anything from this PR, I'll probably close it on behalf of other PR that do this job correctly.

santisoler avatar Sep 20 '21 14:09 santisoler

I'm closing this PR. It's been too long since we started it and it's probably harder to update the branch that to start it from scratch again. I'll leave the branch in the repo in case we want to retake this in the future.

santisoler avatar Mar 17 '23 18:03 santisoler