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 coordinates description in forward functions #413

Merged
merged 1 commit into from
May 19, 2023
Merged

Improve coordinates description in forward functions #413

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions harmonica/_forward/point.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,8 +135,8 @@ def point_gravity(

Parameters
----------
coordinates : list or array
List or array containing the coordinates of computation points in the
coordinates : list of arrays
List of arrays containing the coordinates of computation points in the
following order: ``easting``, ``northing`` and ``upward`` (if
coordinates given in Cartesian coordinates), or ``longitude``,
``latitude`` and ``radius`` (if given on a spherical geocentric
Expand Down
8 changes: 4 additions & 4 deletions harmonica/_forward/prism.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,10 @@ def prism_gravity(

Parameters
----------
coordinates : list or 1d-array
List or array containing ``easting``, ``northing`` and ``upward`` of
the computation points defined on a Cartesian coordinate system.
All coordinates should be in meters.
coordinates : list of arrays
List of arrays containing the ``easting``, ``northing`` and ``upward``
coordinates of the computation points defined on a Cartesian coordinate
system. All coordinates should be in meters.
prisms : list, 1d-array, or 2d-array
List or array containing the coordinates of the prism(s) in the
following order:
Expand Down
8 changes: 4 additions & 4 deletions harmonica/_forward/prism_layer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -329,10 +329,10 @@ def gravity(

Parameters
----------
coordinates : list or 1d-array
List or array containing ``easting``, ``northing`` and ``upward``
of the computation points defined on a Cartesian coordinate system.
All coordinates should be in meters.
coordinates : list of arrays
List of arrays containing the ``easting``, ``northing`` and
``upward`` coordinates of the computation points defined on
a Cartesian coordinate system. All coordinates should be in meters.
field : str
Gravitational field that wants to be computed.
The available fields are:
Expand Down
13 changes: 6 additions & 7 deletions harmonica/_forward/tesseroid.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,12 @@ def tesseroid_gravity(

Parameters
----------
coordinates : list or 1d-array
List or array containing ``longitude``, ``latitude`` and ``radius`` of
the computation points defined on a spherical geocentric coordinate
system.
Both ``longitude`` and ``latitude`` should be in degrees and ``radius``
in meters.
tesseroids : list or 1d-array
coordinates : list of arrays
List of arrays containing the ``longitude``, ``latitude`` and
``radius`` coordinates of the computation points, defined on
a spherical geocentric coordinate system. Both ``longitude`` and
``latitude`` should be in degrees and ``radius`` in meters.
tesseroids : list or 2d-array
List or array containing the coordinates of the tesseroid:
``w``, ``e``, ``s``, ``n``, ``bottom``, ``top`` under a geocentric
spherical coordinate system.
Expand Down
9 changes: 5 additions & 4 deletions harmonica/_forward/tesseroid_layer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,10 +256,11 @@ def gravity(self, coordinates, field, density_name="density", **kwargs):

Parameters
----------
coordinates : list or 1d-array
List of array containing ``latitude``, ``longitude`` and ``upward``
of the computation points defined on a spherical coordinates
system. ``upward`` coordinate should be in meters.
coordinates : list of arrays
List of arrays containing the ``longitude``, ``latitude`` and
``radius`` coordinates of the computation points, defined on
a spherical geocentric coordinate system. Both ``longitude`` and
``latitude`` should be in degrees and ``radius`` in meters.
field : str
Gravitational field that wants to be computed.
The variable fields are:
Expand Down