Skip to content

Add User Guide page on ellipsoids#659

Open
santisoler wants to merge 3 commits intomainfrom
ellipsoid-example
Open

Add User Guide page on ellipsoids#659
santisoler wants to merge 3 commits intomainfrom
ellipsoid-example

Conversation

@santisoler
Copy link
Copy Markdown
Member

Add a new page to the User Guide with instructions and examples on how to forward model gravity and magnetic fields generated by ellipsoids.

Relevant issues/PRs:

Part of #594

Add a new page to the User Guide with instructions and examples on how
to forward model gravity and magnetic fields generated by ellipsoids.
@leouieda leouieda added this to the v0.8.0 milestone Apr 8, 2026
@santisoler santisoler requested a review from leouieda April 8, 2026 18:05
Copy link
Copy Markdown
Member

@leouieda leouieda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Haven't finished but found these things. Looks good so far!

The three semiaxes can be passed in any particular order. For example, we
could define an excentric ellipsoid in the upward direction as follows:

.. code::python
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This code is not being rendered for som reason.

Comment on lines +27 to +30
.. jupyter-execute::
:hide-code:

import harmonica as hm
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've been preferring to import everything at the top and not hide the Harmonica import. Is more like we'd do in an actual notebook or source file and emulates good behavior. It's also nice for people to see import harmonica as hm to build the muscle memory.

ge, gn, gz = hm.ellipsoid_gravity(coordinates, ellipsoids)

.. jupyter-execute::
:hide-code:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd rather not hide code if possible.

other ones using the ``_`` variable name. For example, if we only need the
``gz`` component:

.. code::python
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one also isn't rendering.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants