Skip to content

[Iss566] Handle dataframes in calc_air_density #567

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

Merged
stephenholleran merged 2 commits into from
Dec 17, 2025
Merged

[Iss566] Handle dataframes in calc_air_density #567

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a69ccde
iss #566 raise error if dataframe with more than one column provided
sararafter Dec 16, 2025
c43bea6
iss #566 remove dataframe type and edit tests
sararafter Dec 16, 2025
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
26 changes: 13 additions & 13 deletions brightwind/analyse/analyse.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2042,13 +2042,13 @@ def sector_ratio(wspd_1, wspd_2, wdir, sectors=72, min_wspd=3, direction_bin_arr
return fig


def calc_air_density(temperature: Union[float, pd.Series, pd.DataFrame],
pressure: Union[float, pd.Series, pd.DataFrame],
def calc_air_density(temperature: Union[float, pd.Series],
pressure: Union[float, pd.Series],
elevation_ref: Union[float, int] = None,
elevation_site: Union[float, int] = None,
lapse_rate: float = AIR_DENSITY_LAPSE_RATE,
specific_gas_constant: float = 286.9,
rel_humidity_percent: Union[float, pd.Series, pd.DataFrame] = None
rel_humidity_percent: Union[float, pd.Series] = None
) -> Union[float, pd.Series]:
"""
Calculates air density for a given air temperature (temperature), air pressure (pressure)
Expand All @@ -2072,10 +2072,10 @@ def calc_air_density(temperature: Union[float, pd.Series, pd.DataFrame],
`scale_air_density_to_height()` separately instead.

:param temperature: Air temperature values in degree Celsius
:type temperature: float or pandas.Series or pandas.DataFrame
:type temperature: float or pandas.Series
:param pressure: Air pressure values in hectopascal, hPa or millibar, mbar (Note 1hPa = 1mbar)
(1013.25 hPa = 101,325 Pa = 101.325 kPa = 1 atm = 1013.25 mbar)
:type pressure: float or pandas.Series or pandas.DataFrame
:type pressure: float or pandas.Series
:param elevation_ref: Elevation, in meters, of the reference air density location (and air temperature,
air pressure, relative humidity measurements used for the calculation).
:type elevation_ref: float or int
Expand All @@ -2094,10 +2094,10 @@ def calc_air_density(temperature: Union[float, pd.Series, pd.DataFrame],
:type specific_gas_constant: float
:param rel_humidity_percent: Relative humidity values as a percentage. Default is None. If None, the air density
calculation ignores humidity.
:type rel_humidity_percent: float or pandas.Series or pandas.DataFrame
:type rel_humidity_percent: float or pandas.Series
:return: Air density in kg/m^3. Output type depends on type(temperature), type(pressure),
type(rel_humidity_percent) provided. If all inputs are float, output is float.
If any input is pandas.Series or pandas.DataFrame, output is pandas.Series.
If any input is pandas.Series, output is pandas.Series.
:rtype: float or pandas.Series

**Example usage**
Expand Down Expand Up @@ -2160,18 +2160,18 @@ def calc_air_density(temperature: Union[float, pd.Series, pd.DataFrame],
# 1.198

"""
# Convert DataFrame inputs to Series
# Raise errors if any inputs are DataFrames
if isinstance(temperature, pd.DataFrame):
temperature = _convert_df_to_series(temperature).copy()
raise ValueError("temperature cannot be provided as a DataFrame. Provide as float or pandas Series.")
if isinstance(pressure, pd.DataFrame):
pressure = _convert_df_to_series(pressure).copy()
raise ValueError("pressure cannot be provided as a DataFrame. Provide as float or pandas Series.")
if isinstance(rel_humidity_percent, pd.DataFrame):
rel_humidity_percent = _convert_df_to_series(rel_humidity_percent).copy()

raise ValueError("rel_humidity_percent cannot be provided as a DataFrame. Provide as float or pandas Series.")
# Check dimensions of temperature, pressure and rel_humidity_percent if not float or int
if isinstance(temperature, pd.Series) and (isinstance(pressure, pd.Series)):
if len(temperature) != len(pressure):
raise ValueError("temperature and pressure must have the same dimensions.")
raise ValueError("temperature and pressure must have the same dimensions.")
if isinstance(rel_humidity_percent, pd.Series):
if len(temperature) != len(rel_humidity_percent):
raise ValueError("temperature, pressure and rel_humidity_percent must have the same dimensions.")
Expand Down
10 changes: 2 additions & 8 deletions tests/test_analyse.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -638,12 +638,6 @@ def test_ti_by_sector():


def test_calc_air_density():

# test DataFrame input
assert (bw.calc_air_density(DATA[['T2m']], DATA[['P2m']]).dropna().values ==
bw.calc_air_density(DATA.T2m, DATA.P2m).dropna().values).all()
assert (round(bw.calc_air_density(pd.Series([15, 12.5, -5, 23]), pd.Series([1013, 990, 1020, 900])), 6
) == pd.Series([1.225350, 1.208010, 1.325842, 1.059254])).all()

# test Series inputs
assert list(round(bw.calc_air_density(DATA.T2m, DATA.P2m).tail(5), 6).values
Expand Down Expand Up @@ -684,10 +678,10 @@ def test_calc_air_density():
bw.calc_air_density(15, 1013, elevation_ref=200)
assert str(except_info.value) == "Specify value of elevation_site (float or int) when elevation_ref is provided."
with pytest.raises(ValueError) as except_info:
bw.calc_air_density(DATA.T2m.tail(5), DATA[['P2m']].tail(3), rel_humidity_percent=DATA.RH2m.tail(5))
bw.calc_air_density(DATA.T2m.tail(5), DATA['P2m'].tail(3), rel_humidity_percent=DATA.RH2m.tail(5))
assert str(except_info.value) == "temperature and pressure must have the same dimensions."
with pytest.raises(ValueError) as except_info:
bw.calc_air_density(DATA.T2m.tail(5), DATA[['P2m']].tail(5), rel_humidity_percent=DATA.RH2m.tail(3))
bw.calc_air_density(DATA.T2m.tail(5), DATA['P2m'].tail(5), rel_humidity_percent=DATA.RH2m.tail(3))
assert str(except_info.value) == "temperature, pressure and rel_humidity_percent must have the same dimensions."


Expand Down