Skip to content

PyLance-compatible docstrings and clarifications in point.py, grid.py #114

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

Open
Tyler-g-hudson wants to merge 7 commits into
base: main
Choose a base branch
from
Open

PyLance-compatible docstrings and clarifications in point.py, grid.py #114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7c7868b
Clarify docstrings in grid.py, point.py and reformat them to be compa…
Tyler-g-hudson Mar 5, 2026
399f728
small add'l change
Tyler-g-hudson Mar 5, 2026
0eef26b
Fix small docstring issues in calc_solid_earth_tides_grid and calc_so…
Tyler-g-hudson Mar 5, 2026
2de5cb8
Clarify lat/lon units in calc_solid_earth_tides_point_per_day
Tyler-g-hudson Mar 5, 2026
eae9852
Further documentation clarifications.
Tyler-g-hudson Mar 5, 2026
a669687
Typo fix, specify that step_size is optional in calc_solid_earth_tide…
Tyler-g-hudson Mar 5, 2026
3ffaeaa
Tiny docstring consistency change
Tyler-g-hudson Mar 5, 2026
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
44 changes: 30 additions & 14 deletions src/pysolid/grid.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,36 @@ def calc_solid_earth_tides_grid(dt_obj, atr, step_size=1e3, display=False, verbo
input size. This uses the fact that SET varies slowly in space. Comparison w and w/o step_size
shows a difference in tide_u with max of 5e-8 m, thus negligible.

Parameters: dt_obj - datetime.datetime object (with precision up to the second)
atr - dict, metadata including the following keys:
LENGTH/WIDTTH
X/Y_FIRST
X/Y_STEP
step_size - float, grid step feeded into the fortran code in meters
to speedup the calculation
display - bool, plot the calculated SET
verbose - bool, print verbose message
Returns: tide_e - 2D np.ndarray, SET in east direction in meters
tide_n - 2D np.ndarray, SET in north direction in meters
tide_u - 2D np.ndarray, SET in up direction in meters
Examples: atr = readfile.read_attribute('geo_velocity.h5')
tide_e, tide_n, tide_u = calc_solid_earth_tides_grid('20180219', atr)
Parameters:
dt_obj : datetime.datetime
The datetime to calculate this grid for, with precision up to the second.
atr : dict
metadata including the following keys:
LENGTH/WIDTH
X/Y_FIRST
X/Y_STEP
step_size : float, optional
grid step size in meters; fed into the fortran code to speed up the
calculation. Defaults to 1e3.
display : bool, optional
If True, plot the calculated SET. Defaults to False.
verbose : bool, optional
If True, print verbose messages. Defaults to True.

Returns:
tide_e : 2D np.ndarray of floats
SET in east direction in meters
tide_n : 2D np.ndarray
SET in north direction in meters
tide_u : 2D np.ndarray
SET in up direction in meters

Example:
atr = readfile.read_attribute('geo_velocity.h5')

dt_obj = datetime.datetime(year=2018, month=2, day=19)

tide_e, tide_n, tide_u = calc_solid_earth_tides_grid(dt_obj, atr)
"""
try:
from pysolid.solid import solid_grid
Expand Down
100 changes: 69 additions & 31 deletions src/pysolid/point.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,23 +72,47 @@

################################## Earth tides - point mode ##################################
def calc_solid_earth_tides_point(lat, lon, dt0, dt1, step_sec=60, display=False, verbose=True):
"""Calculate SET in east/north/up direction for the given time period at the given point (lat/lon).

Parameters: lat/lon - float32, latitude/longitude of the point of interest
dt0/1 - datetime.datetime object, start/end date and time
step_sec - int16, time step in seconds
display - bool, plot the calculated SET
verbose - bool, print verbose message
Returns: dt_out - 1D np.ndarray in dt.datetime objects
tide_e - 1D np.ndarray in float32, SET in east direction in meters
tide_n - 1D np.ndarray in float32, SET in north direction in meters
tide_u - 1D np.ndarray in float32, SET in up direction in meters
Examples: dt0 = dt.datetime(2020,11,1,4,0,0)
dt1 = dt.datetime(2020,12,31,2,0,0)
(dt_out,
tide_e,
tide_n,
tide_u) = calc_solid_earth_tides_point(34.0, -118.0, dt0, dt1)
"""
Calculate solid earth tides (SET) in east/north/up direction for the given time
period at the given point.

Parameters:
lat : float
Latitude of the point of interest, in degrees.
lon : float
Longitude of the point of interest, in degrees.
dt0 : datetime.datetime
The datetime of the beginning of the SET calculation.
dt1 : datetime.datetime
The datetime of the end of the SET calculation.
step_sec : int, optional
Time step, in seconds, of the output. Defaults to 60.
display : bool, optional
If True, plot the calculated SET. Defaults to False.
verbose : bool, optional
If True, print verbose messages. Defaults to True.

Returns:
dt_out : 1D np.ndarray of datetime.datetime
The datetimes associated with each index of the following three arrays.
The span of this array will be at least the period between dt0 and dt1.
Note that dt_out is clamped to step_sec, so the start and end times may
be slightly different than dt0 and dt1.
tide_e : 1D np.ndarray of float32
SET in east direction, in meters.
tide_n : 1D np.ndarray of float32
SET in north direction, in meters.
tide_u : 1D np.ndarray of float32
SET in up direction, in meters.

Example:
dt0 = dt.datetime(2020,11,1,4,0,0)

dt1 = dt.datetime(2020,12,31,2,0,0)

(
dt_out, tide_e, tide_n, tide_u
) = calc_solid_earth_tides_point(34.0, -118.0, dt0, dt1)
"""

print('PYSOLID: calculate solid Earth tides in east/north/up direction')
Expand Down Expand Up @@ -144,20 +168,34 @@ def calc_solid_earth_tides_point(lat, lon, dt0, dt1, step_sec=60, display=False,


def calc_solid_earth_tides_point_per_day(lat, lon, date_str, step_sec=60):
"""Calculate solid Earth tides (SET) in east/north/up direction
for one day at the given point (lat/lon).

Parameters: lat/lon - float32, latitude/longitude of the point of interest
date_str - str, date in YYYYMMDD
step_sec - int16, time step in seconds
Returns: dt_out - 1D np.ndarray in dt.datetime objects
tide_e - 1D np.ndarray in float32, SET in east direction in meters
tide_n - 1D np.ndarray in float32, SET in north direction in meters
tide_u - 1D np.ndarray in float32, SET in up direction in meters
Examples: (dt_out,
tide_e,
tide_n,
tide_u) = calc_solid_earth_tides_point_per_day(34.0, -118.0, '20180219')
"""
Calculate solid Earth tides (SET) in east/north/up direction for one day at the
given point (lat/lon).

Parameters:
lat : float
Latitude of the point of interest, in degrees.
lon : float
Longitude of the point of interest, in degrees.
date_str : str
The date to generate solid earth tides for, in YYYYMMDD format.
step_sec : int, optional
Time step, in seconds, of the output. Defaults to 60.

Returns:
dt_out : 1D np.ndarray of datetime.datetime
The datetimes associated with each index of the following three arrays.
tide_e : 1D np.ndarray of float32
SET in east direction, in meters.
tide_n : 1D np.ndarray of float32
SET in north direction, in meters.
tide_u : 1D np.ndarray of float32
SET in up direction, in meters.

Example:
(
dt_out, tide_e, tide_n, tide_u
) = calc_solid_earth_tides_point_per_day(34.0, -118.0, '20180219')
"""
try:
from pysolid.solid import solid_point
Expand Down