Skip to content

Commit f0fc644

Browse files
committed
Revert previous fix and instead add docs about the units
1 parent 838c7fd commit f0fc644

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

pejzero/pejzero.py

+6-6
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ def cal_pej0_for_each_flowline(flowline_obj, speed_data, vdiff_data, size_limit=
155155
Returns:
156156
- data group: dict object with the following entries:
157157
158-
--- d: distance (m)
158+
--- d: distance (km)
159159
--- s: surface elevation (m)
160160
--- b: bed elevation (m)
161161
--- u: reference glacier speed used for claculating Pe and J0 (m/yr)
@@ -304,18 +304,18 @@ def cal_pej0_for_each_flowline_raw(d, s, b, u, size_limit=280, minimum_amount_va
304304
Similar to cal_pej0_for_each_flowline, this function calculates Pe and J0 but without fancy I/O and sampling of glacier speed from a target year.
305305
306306
Arguments:
307-
- d: distance along the flowline, from terminus
308-
- s: surface elevation
309-
- b: bed elevation
310-
- u: speed
307+
- d: distance along the flowline, FROM terminus (m)
308+
- s: surface elevation (m)
309+
- b: bed elevation (m)
310+
- u: speed (m/yr)
311311
- size_limit: minimum size to start calculation, otherwise return None
312312
- minimum_amount_valid_u: minimum amount of valid u measurements, otherwise return None
313313
- savgol_winlength: Savgol filter window length.
314314
315315
Returns:
316316
- data group: dict object with the following entries:
317317
318-
--- d: distance (m)
318+
--- d: distance (km)
319319
--- s: surface elevation (m)
320320
--- b: bed elevation (m)
321321
--- u: reference glacier speed used for claculating Pe and J0 (m/yr)

0 commit comments

Comments
 (0)