From b9bfd4cb6f9521ba40300f15ca2b527904d5f348 Mon Sep 17 00:00:00 2001 From: Mikkel Pedersen Date: Thu, 9 Jan 2025 15:28:21 +0100 Subject: [PATCH] docs(metrics): ASE docstring --- honeybee_radiance_postprocess/metrics.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/honeybee_radiance_postprocess/metrics.py b/honeybee_radiance_postprocess/metrics.py index 35a0aca6..15c91adc 100644 --- a/honeybee_radiance_postprocess/metrics.py +++ b/honeybee_radiance_postprocess/metrics.py @@ -295,11 +295,16 @@ def ase_array2d( Defaults to 1000. Returns: - A NumPy float of the ASE as a percentage (decimal). + A Tuple with two values. + + - ase: NumPy float of the ASE as a percentage (decimal). + + - h_above: 1D NumPy array of the number of hours above the direct + threshold. """ check_array_dim(array, 2) h_above = (array > direct_threshold).sum(axis=1) - ase = (h_above > occ_hours).sum() / array.shape[0] * 100 + ase = (h_above >= occ_hours).sum() / array.shape[0] * 100 return ase, h_above