Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve docstring of prism_magnetic function #481

Merged
merged 2 commits into from
Mar 27, 2024
Merged

Improve docstring of prism_magnetic function #481

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aafa32b
Improve docstring of `prism_magnetic` function
santisoler Mar 22, 2024
6fe0563
Merge branch 'main' into prism-mag-docs
santisoler Mar 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion harmonica/_forward/prism_magnetic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,13 @@ def prism_magnetic(
"""
Magnetic field of right-rectangular prisms in Cartesian coordinates

Compute the component(s) of the magnetic field vector generated by
a collection of prisms on a set of observation points.

.. important::

The component(s) of the magnetic field are returned in :math:`nT`.

Parameters
----------
coordinates : list of arrays
Expand Down Expand Up @@ -84,7 +91,9 @@ def prism_magnetic(
Returns
-------
magnetic_field : array or tuple of arrays
Array with the computed magnetic field on every observation point.
Computed magnetic field on every observation point in :math:`nT`.
If ``field`` is set to a single component, then a single array with the
computed magnetic field component will be returned.
If ``field`` is set to ``"b"``, then a tuple containing the three
components of the magnetic vector will be returned in the following
order: ``b_e``, ``b_n``, ``b_u``.
Expand Down