From 36d4d17da20a11d597d990f9bcf34ba43e607d7a Mon Sep 17 00:00:00 2001 From: XANTRONIX Industrial Date: Sat, 8 Mar 2025 14:36:46 -0500 Subject: [PATCH] Add docstrings to Series derivations --- lib/xmet/thermo.py | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/lib/xmet/thermo.py b/lib/xmet/thermo.py index 3a01ea7..5410411 100644 --- a/lib/xmet/thermo.py +++ b/lib/xmet/thermo.py @@ -145,6 +145,10 @@ def loft_parcel(start_temp: float, pressure -= step def follow_dry_adiabat(temp: float, pressure: float) -> Series: + """ + Follow a dry adiabat starting at a given temp and pressure level, returning + a Series object depicting the data points in descending pressure order. + """ series = Series() for level in loft_parcel(temp, pressure, lambda t, p: LAPSE_RATE_DRY): @@ -155,6 +159,11 @@ def follow_dry_adiabat(temp: float, pressure: float) -> Series: return series def follow_moist_adiabat(temp: float, pressure: float) -> Series: + """ + Follow a moist adiabat starting at a given temp and pressure level, + returning a Series object depicting the data points in descending pressure + order. + """ series = Series() for level in loft_parcel(temp, pressure, moist_lapse_rate): @@ -165,6 +174,11 @@ def follow_moist_adiabat(temp: float, pressure: float) -> Series: return series def follow_saturated_mixing_ratio(temp: float, pressure: float) -> Series: + """ + Follow a line of constant saturated mixing ratio calculated from a given + temp and pressure level, returning a Series object depicting the data + points in descending pressure order. + """ series = dict() ratio = saturated_mixing_ratio(temp, pressure)