linerate 2.1.3__tar.gz → 2.2.1__tar.gz

{linerate-2.1.3 → linerate-2.2.1}/.github/workflows/tests.yml

@@ -1,10 +1,10 @@
 ---
-  name: Lint and Test
+  name: Lint, type check and test
 
   on: [push, pull_request]
 
   jobs:
-    lint:
+    lint-and-type-check:
       runs-on: ubuntu-latest
       strategy:
         matrix:
@@ -17,7 +17,7 @@
           uses: astral-sh/setup-uv@b75a909f75acd358c2196fb9a5f1299a9a8868a4 # v6
           with:
             python-version: ${{ matrix.python-version }}
-        - name: Run linting
+        - name: Run linting and type checking
           run: |
             uv run --frozen pre-commit run --all-files
 

{linerate-2.1.3 → linerate-2.2.1}/.pre-commit-config.yaml

@@ -21,3 +21,7 @@ repos:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
       - id: ruff-format
+  - repo: https://github.com/RobertCraigie/pyright-python
+    rev: v1.1.408
+    hooks:
+      - id: pyright

{linerate-2.1.3 → linerate-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: linerate
-Version: 2.1.3
+Version: 2.2.1
 Summary: Library for computing line ampacity ratings for overhead lines
 Author-email: Statnett Datascience <Datascience.Drift@Statnett.no>, Yngve Mardal Moe <yngve.m.moe@gmail.com>
 Requires-Python: >=3.9

{linerate-2.1.3 → linerate-2.2.1}/examples/plot_solar_heating_comparison.py

@@ -73,7 +73,10 @@ for k, v in vals_with_range.items():
     # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
     P_s_cigre = solar_heating.compute_solar_heating(alpha_s, I_T, D)
+    assert isinstance(P_s_cigre, np.ndarray)
+
     P_s_ieee = ieee738.solar_heating.compute_solar_heating(alpha_s, Q_se, cos_theta, D)
+    assert isinstance(P_s_ieee, np.ndarray)
 
     ###############################################################################
     # Create visualisation
@@ -92,7 +95,7 @@ for k, v in vals_with_range.items():
         )
     elif k == "sin_H_s":
         plt.xlabel("Solar altitude [$^\\circ$]")
-        plt.xticks(ticks=[0, 1 / 3, 2 / 3, 1], labels=[0, 30, 60, 90])
+        plt.xticks(ticks=[0, 1 / 3, 2 / 3, 1], labels=["0", "30", "60", "90"])
         plt.title(
             r"Solar heating calculated using the CIGRE-601 and the IEEE-736 standards."
             "\n"

{linerate-2.1.3 → linerate-2.2.1}/examples/plot_solar_radiation.py

@@ -11,7 +11,6 @@ the difference between the solar azimuth and the span azimuth (or bearing),
 # Imports and utilities
 # ^^^^^^^^^^^^^^^^^^^^^
 
-import matplotlib.cm as cm
 import matplotlib.pyplot as plt
 import numpy as np
 
@@ -45,9 +44,12 @@ I_d = cigre601.solar_heating.compute_diffuse_sky_radiation(I_B, sin_H_s)
 I_T_F0 = cigre601.solar_heating.compute_global_radiation_intensity(
     I_B, I_d, albedo=0.0, sin_angle_of_sun_on_line=sin_eta, sin_solar_altitude=sin_H_s
 )
+assert isinstance(I_T_F0, np.ndarray)
+
 I_T_F = cigre601.solar_heating.compute_global_radiation_intensity(
     I_B, I_d, albedo=albedo, sin_angle_of_sun_on_line=sin_eta, sin_solar_altitude=sin_H_s
 )
+assert isinstance(I_T_F, np.ndarray)
 
 ###############################################################################
 # Create visualisation
@@ -57,19 +59,20 @@ I_T_F = cigre601.solar_heating.compute_global_radiation_intensity(
 
 # Setup figure and axes
 fig = plt.figure(figsize=(11, 1.9))
-axes = [fig.add_axes([0.07, 0.27, 0.19, 0.7])]
+axes = [fig.add_axes((0.07, 0.27, 0.19, 0.7))]
 axes += [
-    fig.add_axes([0.30, 0.27, 0.18, 0.7], sharey=axes[0]),
-    fig.add_axes([0.53, 0.27, 0.18, 0.7], sharey=axes[0]),
-    fig.add_axes([0.76, 0.27, 0.18, 0.7], sharey=axes[0]),
+    fig.add_axes((0.30, 0.27, 0.18, 0.7), sharey=axes[0]),
+    fig.add_axes((0.53, 0.27, 0.18, 0.7), sharey=axes[0]),
+    fig.add_axes((0.76, 0.27, 0.18, 0.7), sharey=axes[0]),
 ]
-cbar_ax = fig.add_axes([0.955, 0.27, 0.015, 0.7])
+cbar_ax = fig.add_axes((0.955, 0.27, 0.015, 0.7))
 
 # Add plots
 axes[0].plot(np.degrees(solar_altitude), I_B, color="k")
 axes[1].plot(np.degrees(solar_altitude), I_d, color="k")
+cmap = plt.get_cmap("cividis")
 for i, d_gamma in enumerate(azimuth_difference.ravel()):
-    color = cm.cividis(d_gamma / azimuth_difference.max())
+    color = cmap(d_gamma / azimuth_difference.max())
     d_gamma = np.degrees(d_gamma)
     axes[2].plot(np.degrees(solar_altitude), I_T_F0[:, i], color=color)
     axes[3].plot(np.degrees(solar_altitude), I_T_F[:, i], color=color)
@@ -84,7 +87,7 @@ for ax in axes:
     # Setup y-axes to be shared
     ax.set_ylim(0, I_T_F.max() * 1.05)
     ax.set_yticks([0, 500, 1000, 1360])  # Include tick for solar constant
-    ax.set_yticklabels([0, 500, 1000, "$G_{SC}$"])
+    ax.set_yticklabels(["0", "500", "1000", "$G_{SC}$"])
     ax.axhline(1360, color="k", linestyle="--")  # Add dashed line for solar constant
 
 
@@ -96,8 +99,8 @@ axes[3].tick_params(labelleft=False)
 # Setup labels
 axes[0].set_ylabel(r"$I_B~[\mathrm{W}~\mathrm{m}^{-1}]$", labelpad=-1)
 axes[1].set_ylabel(r"$I_d~[\mathrm{W}~\mathrm{m}^{-1}]$")
-axes[2].set_ylabel("$F=0$\n$I_T~[\mathrm{W}~\mathrm{m}^{-1}]$")  # noqa
-axes[3].set_ylabel(f"$F={albedo}$\n$I_T~[\mathrm{{W}}~\mathrm{{m}}^{{-1}}]$")  # noqa
+axes[2].set_ylabel(r"$F=0$\n$I_T~[\mathrm{W}~\mathrm{m}^{-1}]$")  # noqa
+axes[3].set_ylabel(rf"$F={albedo}$\n$I_T~[\mathrm{{W}}~\mathrm{{m}}^{{-1}}]$")  # noqa
 
 # Colorbar
 cbar_ax.imshow(azimuth_difference.T, aspect="auto", cmap="cividis")
@@ -105,7 +108,7 @@ cbar_ax.yaxis.set_label_position("right")
 cbar_ax.set_ylabel(r"$\left|\gamma_c - \gamma_s\right|~[^\circ]$", labelpad=-10)
 cbar_ax.yaxis.tick_right()
 cbar_ax.set_yticks(cbar_ax.get_ylim())
-cbar_ax.set_yticklabels([0, 90])
+cbar_ax.set_yticklabels(["0", "90"])
 cbar_ax.set_xticks([])
 
 plt.show()

{linerate-2.1.3 → linerate-2.2.1}/linerate/equations/ieee738/convective_cooling.py

@@ -190,7 +190,7 @@ def compute_forced_convection(  # q_c1 or q_c2
     q_c1 = K_angle * (1.01 + 1.35 * N_Re**0.52) * k_f * (T_s - T_a)
     q_c2 = K_angle * 0.754 * N_Re**0.6 * k_f * (T_s - T_a)
 
-    if hasattr(q_c1, "__len__"):
+    if isinstance(q_c1, np.ndarray) and isinstance(q_c2, np.ndarray):
         q_cf = []
         for i in range(len(q_c1)):
             if q_c1[i] > q_c2[i]:

{linerate-2.1.3 → linerate-2.2.1}/linerate/equations/solar_angles.py

@@ -1,16 +1,17 @@
 import numpy as np
 from numba import vectorize
+
 from linerate.equations import math
 
-from ..units import Date, Degrees, Radian, Unitless
 from ..types import Span
+from ..units import Date, Degrees, Radian, Unitless
 
 
 def _get_day_of_year(when: Date) -> Unitless:
     YearResolutionType = np.datetime64(1, "Y")
     DayResolutionType = np.datetime64(1, "D")
 
-    return (when.astype(DayResolutionType) - when.astype(YearResolutionType)).astype(float) + 1
+    return (when.astype(DayResolutionType) - when.astype(YearResolutionType)).astype(float) + 1.0
 
 
 def _get_hour_of_day(when: Date) -> Unitless:
@@ -55,9 +56,11 @@ def compute_hour_angle_relative_to_noon(when: Date, longitude: Degrees) -> Radia
     utc_minute = _get_minute_of_hour(when)
     pi = np.pi
     # We add longitude/15 since 15 degrees of longitude increases solar hour by 1
-    return np.mod((-12 + utc_hour + utc_minute / 60 + longitude / 15), 24) * (
+    hour_angle = np.mod((-12 + utc_hour + utc_minute / 60 + longitude / 15), 24) * (
         pi / 12
     )  # pi/12 is 15 degrees
+    # Shift to [-pi, pi] range to ensure negative values before noon
+    return np.where(hour_angle >= pi, hour_angle - 2 * pi, hour_angle)
 
 
 def compute_solar_declination(
@@ -123,13 +126,16 @@ def _compute_solar_azimuth_constant(
     if -pi <= omega < 0:
         if chi >= 0:
             C = 0
-        elif chi < 0:
+        else:
             C = pi
     elif 0 <= omega < pi:
         if chi >= 0:
             C = pi
-        elif chi < 0:
+        else:
             C = 2 * pi
+    else:
+        raise ValueError(f"Hour angle {omega} out of range [-π, π)")
+
     return C
 
 
@@ -138,7 +144,7 @@ def compute_solar_azimuth_constant(
 ) -> Radian:
     r"""Compute the solar azimuth constant.
 
-    Table 2 on page 18 of:cite:p:`ieee738`.
+    Table 2 on page 18 of :cite:p:`ieee738`.
 
     Parameters
     ----------

{linerate-2.1.3 → linerate-2.2.1}/linerate/models/cigre207.py

@@ -60,7 +60,7 @@ class Cigre207(ThermalModel):
         )
         if self.include_diffuse_radiation:
             I_d = cigre207.solar_heating.compute_diffuse_sky_radiation(I_B, sin_H_s)
-            F = self.span.ground_albedo
+            F = self.weather.ground_albedo
         else:
             I_d = 0
             F = 0

{linerate-2.1.3 → linerate-2.2.1}/linerate/models/cigre601.py

@@ -1,5 +1,3 @@
-from numbers import Real
-
 import numpy as np
 
 from linerate.equations import (
@@ -11,24 +9,25 @@ from linerate.equations import (
     solar_heating,
 )
 from linerate.models.thermal_model import ThermalModel, _copy_method_docstring
-from linerate.types import Span, Weather, WeatherWithSolarRadiation
+from linerate.types import BaseWeather, Span, Weather, WeatherWithSolarRadiation
 from linerate.units import (
     Ampere,
     Celsius,
     Date,
     JoulePerKilogramPerKelvin,
     OhmPerMeter,
+    Unitless,
     WattPerMeter,
 )
 
 
-class Cigre601(ThermalModel):
+class BaseCigre601(ThermalModel):
     def __init__(
         self,
         span: Span,
-        weather: Weather,
+        weather: BaseWeather,
         time: Date,
-        max_reynolds_number: Real = 4000,  # Max value of the angle correction in CIGRE601
+        max_reynolds_number: Unitless = 4000.0,  # Max value of the angle correction in CIGRE601
     ):
         super().__init__(span, weather)
         self.time = time
@@ -48,33 +47,6 @@ class Cigre601(ThermalModel):
             conductor_temperature=conductor_temperature, current=current
         )
 
-    @_copy_method_docstring(ThermalModel)
-    def compute_solar_heating(
-        self, conductor_temperature: Celsius, current: Ampere
-    ) -> WattPerMeter:
-        alpha_s = self.span.conductor.solar_absorptivity
-        F = self.weather.ground_albedo
-        y = self.span.conductor_altitude
-        N_s = self.weather.clearness_ratio
-        D = self.span.conductor.conductor_diameter
-
-        sin_H_s = solar_angles.compute_sin_solar_altitude_for_span(self.span, self.time)
-
-        sin_eta = solar_angles.compute_sin_solar_effective_incidence_angle_for_span(
-            self.span, self.time, sin_H_s
-        )
-
-        I_B = cigre601.solar_heating.compute_direct_solar_radiation(sin_H_s, N_s, y)
-        I_d = cigre601.solar_heating.compute_diffuse_sky_radiation(I_B, sin_H_s)
-        I_T = cigre601.solar_heating.compute_global_radiation_intensity(
-            I_B, I_d, F, sin_eta, sin_H_s
-        )
-        return solar_heating.compute_solar_heating(
-            alpha_s,
-            I_T,
-            D,
-        )
-
     @_copy_method_docstring(ThermalModel)
     def compute_convective_cooling(
         self, conductor_temperature: Celsius, current: Ampere
@@ -169,12 +141,55 @@ class Cigre601(ThermalModel):
         )
 
 
-class Cigre601WithSolarRadiation(Cigre601):
+class Cigre601(BaseCigre601):
+    def __init__(
+        self,
+        span: Span,
+        weather: Weather,
+        time: Date,
+        max_reynolds_number: Unitless = 4000.0,  # Max value of the angle correction in CIGRE601
+    ):
+        self.span = span
+        self.weather = weather
+        self.time = time
+        self.max_reynolds_number = max_reynolds_number
+
+    @_copy_method_docstring(ThermalModel)
+    def compute_solar_heating(
+        self, conductor_temperature: Celsius, current: Ampere
+    ) -> WattPerMeter:
+        alpha_s = self.span.conductor.solar_absorptivity
+        F = self.weather.ground_albedo
+        y = self.span.conductor_altitude
+        N_s = self.weather.clearness_ratio
+        D = self.span.conductor.conductor_diameter
+
+        sin_H_s = solar_angles.compute_sin_solar_altitude_for_span(self.span, self.time)
+
+        sin_eta = solar_angles.compute_sin_solar_effective_incidence_angle_for_span(
+            self.span, self.time, sin_H_s
+        )
+
+        I_B = cigre601.solar_heating.compute_direct_solar_radiation(sin_H_s, N_s, y)
+        I_d = cigre601.solar_heating.compute_diffuse_sky_radiation(I_B, sin_H_s)
+        I_T = cigre601.solar_heating.compute_global_radiation_intensity(
+            I_B, I_d, F, sin_eta, sin_H_s
+        )
+        return solar_heating.compute_solar_heating(
+            alpha_s,
+            I_T,
+            D,
+        )
+
+
+class Cigre601WithSolarRadiation(BaseCigre601):
     """Extension of the Cigre601 model that accepts external solar radiation data for direct and diffuse solar
     radiation."""
 
     def __init__(self, span: Span, weather: WeatherWithSolarRadiation, time: Date):
-        super().__init__(span, weather, time)
+        self.span = span
+        self.weather = weather
+        self.time = time
         self.weather = weather
 
     def compute_solar_heating(

{linerate-2.1.3 → linerate-2.2.1}/linerate/models/ieee738.py

@@ -1,11 +1,9 @@
-from numbers import Real
-
 import numpy as np
 
 from linerate.equations import dimensionless, ieee738, math, solar_angles
 from linerate.models.thermal_model import ThermalModel, _copy_method_docstring
 from linerate.types import Span, Weather
-from linerate.units import Ampere, Celsius, Date, OhmPerMeter, WattPerMeter
+from linerate.units import Ampere, Celsius, Date, OhmPerMeter, Unitless, WattPerMeter
 
 
 class IEEE738(ThermalModel):
@@ -14,7 +12,7 @@ class IEEE738(ThermalModel):
         span: Span,
         weather: Weather,
         time: Date,
-        max_reynolds_number: Real = 50_000,  # Max Reynolds number for forced convection
+        max_reynolds_number: Unitless = 50_000.0,  # Max Reynolds number for forced convection
     ):
         super().__init__(span, weather)
         self.time = time

{linerate-2.1.3 → linerate-2.2.1}/linerate/models/thermal_model.py

@@ -3,7 +3,7 @@ from typing import Dict
 
 from linerate import solver
 from linerate.equations import joule_heating, radiative_cooling
-from linerate.types import Span, Weather
+from linerate.types import BaseWeather, Span
 from linerate.units import Ampere, Celsius, OhmPerMeter, WattPerMeter
 
 
@@ -19,7 +19,7 @@ class ThermalModel(ABC):
     """Abstract class for a minimal conductor thermal model."""
 
     @abstractmethod
-    def __init__(self, span: Span, weather: Weather):
+    def __init__(self, span: Span, weather: BaseWeather):
         self.span = span
         self.weather = weather
 
@@ -198,6 +198,7 @@ class ThermalModel(ABC):
         min_ampacity: Ampere = 0,
         max_ampacity: Ampere = 5000,
         tolerance: float = 1.0,
+        accept_invalid_values: bool = False,
     ) -> Ampere:
         r"""Use the bisection method to compute the steady-state thermal rating (ampacity).
 
@@ -216,6 +217,9 @@ class ThermalModel(ABC):
             bisection iterations will stop once the numerical ampacity uncertainty is below
             :math:`\Delta I`. The bisection method will run for
             :math:`\left\lceil\frac{I_\text{min} - I_\text{min}}{\Delta I}\right\rceil` iterations.
+        accept_invalid_values:
+            If True, np.nan is returned whenever the current cannot be found within the provided
+            search interval. If False, a ValueError will be raised instead.
 
         Returns
         -------
@@ -228,6 +232,7 @@ class ThermalModel(ABC):
             min_ampacity=min_ampacity,
             max_ampacity=max_ampacity,
             tolerance=tolerance,
+            accept_invalid_values=accept_invalid_values,
         )
         n = self.span.num_conductors
         return I * n

{linerate-2.1.3 → linerate-2.2.1}/linerate/solver.py

@@ -1,5 +1,5 @@
 from functools import partial
-from typing import Callable, Optional
+from typing import Callable
 
 import numpy as np
 
@@ -13,7 +13,7 @@ def bisect(
     xmin: FloatOrFloatArray,
     xmax: FloatOrFloatArray,
     tolerance: float,
-    invalid_value: Optional[float] = None,
+    accept_invalid_values: bool = False,
 ) -> FloatOrFloatArray:
     r"""Compute the roots of a function using a vectorized bisection method.
 
@@ -32,10 +32,10 @@ def bisect(
         bounded within an interval of size :math:`\Delta x` or less. The bisection method will
         run for :math:`\left\lceil\frac{x_\max - x_\min}{\Delta x}\right\rceil`
         iterations.
-    invalid_value:
-        This value is used whenever
-        :math:`\text{sign}(f(\mathbf{x}_\min)) = \text{sign}(f(\mathbf{x}_\max))`. If not provided
-        np.nan is used.
+    accept_invalid_values:
+        If True, np.nan is returned whenever
+        :math:`\text{sign}(f(\mathbf{x}_\min)) = \text{sign}(f(\mathbf{x}_\max))`
+        If False, a ValueError will be raised.
 
     Returns
     -------
@@ -44,7 +44,7 @@ def bisect(
         there is a root :math:`x_i \in [\tilde{x}_i - 0.5 \Delta x, \tilde{x}_i + 0.5 \Delta x]`
         so :math:`f_i(x_i) = 0`.
     """
-    _invalid_value = np.nan if invalid_value is None else invalid_value
+    _invalid_value = np.nan
 
     if not np.all(np.isfinite(xmin)) or not np.all(np.isfinite(xmax)):
         raise ValueError("xmin and xmax must be finite.")
@@ -54,7 +54,7 @@ def bisect(
     f_right = f(xmax)
 
     invalid_mask = np.sign(f_left) == np.sign(f_right)
-    if np.any(invalid_mask) and invalid_value is None:
+    if np.any(invalid_mask) and not accept_invalid_values:
         raise ValueError(
             "f(xmin) and f(xmax) have the same sign. Consider increasing the search interval."
         )
@@ -114,7 +114,9 @@ def compute_conductor_temperature(
     Union[float, float64, ndarray[Any, dtype[float64]]]
         :math:`I~\left[\text{A}\right]`. The thermal rating.
     """
-    f = partial(heat_balance, current=current)
+
+    def f(conductor_temperature: Celsius) -> WattPerMeter:
+        return heat_balance(conductor_temperature, current)
 
     return bisect(f, min_temperature, max_temperature, tolerance)
 
@@ -125,7 +127,7 @@ def compute_conductor_ampacity(
     min_ampacity: Ampere = 0,
     max_ampacity: Ampere = 5_000,
     tolerance: float = 1,  # Ampere
-    invalid_value=None,
+    accept_invalid_values: bool = False,
 ) -> Ampere:
     r"""Use the bisection method to compute the steady-state thermal rating (ampacity).
 
@@ -148,10 +150,9 @@ def compute_conductor_ampacity(
         bisection iterations will stop once the numerical ampacity uncertainty is below
         :math:`\Delta I`. The bisection method will run for
         :math:`\left\lceil\frac{I_\text{max} - I_\text{min}}{\Delta I}\right\rceil` iterations.
-    invalid_value:
-        if the optimization problem is invalid, this value is returned instead of an error.
-        Suggested value: 0 for 0-ampacity when max_conductor_temperature is exceeded for all
-        ampacities.
+    accept_invalid_values:
+        If True, np.nan is returned whenever the current cannot be found within the provided
+        search interval. If False, a ValueError will be raised instead.
 
     Returns
     -------
@@ -160,4 +161,6 @@ def compute_conductor_ampacity(
     """
     f = partial(heat_balance, max_conductor_temperature)
 
-    return bisect(f, min_ampacity, max_ampacity, tolerance, invalid_value=invalid_value)
+    return bisect(
+        f, min_ampacity, max_ampacity, tolerance, accept_invalid_values=accept_invalid_values
+    )

{linerate-2.1.3 → linerate-2.2.1}/linerate/types.py

@@ -163,8 +163,8 @@ class Span:
         return 0.5 * (self.start_tower.altitude + self.end_tower.altitude)
 
 
-@dataclass()
-class Weather:
+@dataclass
+class BaseWeather:
     #: :math:`T_a~\left[^\circ C\right]`. The ambient air temperature.
     air_temperature: Celsius
     #: :math:`\delta~\left[\text{radian}\right]`. Wind direction east of north.
@@ -173,24 +173,21 @@ class Weather:
     wind_speed: MeterPerSecond
     #: :math:`F`.  The ground albedo.
     ground_albedo: Unitless
+
+
+@dataclass
+class Weather(BaseWeather):
     #: :math:`N_s`. The clearness ratio (or clearness number in
     #: :cite:p:`sharma1965interrelationships,cigre207`).
     clearness_ratio: Unitless = 1
 
 
 @dataclass
-class WeatherWithSolarRadiation(Weather):
+class WeatherWithSolarRadiation(BaseWeather):
     """Extension of the Weather class to accept solar radiation timeseries."""
 
     #: :math:`I_d~\left[\text{W}~\text{m}^{-2}\right]`. The diffuse radiation intensity.
-    diffuse_radiation_intensity: WattPerSquareMeter = None
+    diffuse_radiation_intensity: WattPerSquareMeter
     #: :math:`I_B~\left[\text{W}~\text{m}^{-2}\right]`. The direct radiation intensity on a surface normal to the
     # sun's beam.
-    direct_radiation_intensity: WattPerSquareMeter = None
-
-    def __post_init__(self):
-        if (self.diffuse_radiation_intensity is None) or (self.direct_radiation_intensity is None):
-            raise ValueError(
-                "Both 'diffuse_radiation_intensity' and 'direct_radiation_intensity' must be provided. For weather"
-                " data without solar radiation, use the 'Weather' class instead.",
-            )
+    direct_radiation_intensity: WattPerSquareMeter

{linerate-2.1.3 → linerate-2.2.1}/linerate/units.py

@@ -8,7 +8,7 @@ except ImportError:  # Python version <3.9
 import numpy as np
 import numpy.typing as npt
 
-FloatOrFloatArray = Union[float, np.float64, npt.NDArray[np.float64]]
+FloatOrFloatArray = Union[float, np.floating, npt.NDArray[np.floating]]
 BoolOrBoolArray = Union[bool, np.bool_, npt.NDArray[np.bool_]]
 
 OhmPerMeter = Annotated[FloatOrFloatArray, "Ω/m"]

{linerate-2.1.3 → linerate-2.2.1}/linerate.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: linerate
-Version: 2.1.3
+Version: 2.2.1
 Summary: Library for computing line ampacity ratings for overhead lines
 Author-email: Statnett Datascience <Datascience.Drift@Statnett.no>, Yngve Mardal Moe <yngve.m.moe@gmail.com>
 Requires-Python: >=3.9

{linerate-2.1.3 → linerate-2.2.1}/pyproject.toml

@@ -24,6 +24,8 @@ dev = [
   "pytest==8.4.2",
   "pytest-cov==7.0.0",
   "pytest-randomly==4.0.1",
+  "pyright[nodejs]",
+  "matplotlib>=3.9.4",
 ]
 docs = [
   "sphinx",
@@ -94,3 +96,7 @@ filterwarnings = [
 [build-system]
 requires = ["setuptools>=64", "setuptools-scm>=8"]
 build-backend = "setuptools.build_meta"
+
+[tool.pyright]
+venvPath = "."
+venv = ".venv"

{linerate-2.1.3 → linerate-2.2.1}/tests/conftest.py

@@ -1,8 +1,11 @@
+from typing import Callable
+
 import hypothesis
 import numpy as np
 import pytest
 
 import linerate
+from linerate.units import Ampere, Celsius, WattPerMeter
 
 hypothesis.settings.register_profile("default", deadline=None)
 hypothesis.settings.load_profile("default")
@@ -86,3 +89,13 @@ def example_model_2_conductors(example_span_2_conductors, example_weather_a):
     return linerate.Cigre601(
         example_span_2_conductors, example_weather_a, np.datetime64("2016-06-10 11:00")
     )
+
+
+@pytest.fixture
+def heat_balance() -> Callable[[Celsius, Ampere], WattPerMeter]:
+    def _heat_balance(conductor_temperature: Celsius, current: Ampere) -> WattPerMeter:
+        I = current  # noqa: E741
+        T = conductor_temperature
+        return (I - 100 * T) * (I + 100 * T)
+
+    return _heat_balance

{linerate-2.1.3 → linerate-2.2.1}/tests/equations/test_solar_angles.py

@@ -131,6 +131,7 @@ def test_solar_declination_scales_correctly_with_day_of_year(day):
 )
 def test_solar_declination_scales_with_dates_and_times(when, longitude):
     omega = ((-12 + when.hour + when.minute / 60 + longitude / 15) % 24) * np.pi / 12
+    omega = np.where(omega >= np.pi, omega - 2 * np.pi, omega)
     when = np.datetime64(when)
     assert omega == approx(solar_angles.compute_hour_angle_relative_to_noon(when, longitude))
 
@@ -189,6 +190,7 @@ def test_compute_sin_solar_altitude_for_span(example_span_1_conductor):
     )
     sin_H_s = solar_angles.compute_sin_solar_altitude_for_span(example_span_1_conductor, time)
 
+    assert isinstance(sin_H_s, np.ndarray)
     assert sin_H_s.shape == time.shape
 
     assert sin_H_s == approx(
@@ -231,6 +233,7 @@ def test_compute_sin_solar_effective_incidence_angle_for_span(example_span_1_con
         example_span_1_conductor, time, sin_H_s
     )
 
+    assert isinstance(sin_eta, np.ndarray)
     assert sin_eta.shape == time.shape
 
     assert sin_eta == approx(

{linerate-2.1.3 → linerate-2.2.1}/tests/integration_tests/test_vectorization.py

@@ -61,4 +61,6 @@ def test_vectorization(vectorization_indices):
     for vectorisation_index in vectorization_indices:
         shape[vectorisation_index] = 2
     shape[0] = 1
+
+    assert isinstance(temperature, np.ndarray)
     assert temperature.shape == tuple(shape)

{linerate-2.1.3 → linerate-2.2.1}/tests/test_solver.py

@@ -1,27 +1,25 @@
+from collections.abc import Callable
+from functools import partial
+
 import numpy as np
 import pytest
 
 import linerate.solver as solver
+from linerate.units import Ampere, Celsius, WattPerMeter
 
 
-def test_compute_conductor_temperature_computes_correct_temperature():
-    def heat_balance(conductor_temperature, current):
-        A = current
-        T = conductor_temperature
-        return (A - 100 * T) * (current + 100 * T)
-
+def test_compute_conductor_temperature_computes_correct_temperature(
+    heat_balance: Callable[[Celsius, Ampere], WattPerMeter],
+):
     conductor_temperature = solver.compute_conductor_temperature(
         heat_balance, current=1500, min_temperature=0, max_temperature=150, tolerance=1e-8
     )
     assert conductor_temperature == pytest.approx(15, rel=1e-7)
 
 
-def test_compute_conductor_ampacity_computes_correct_ampacity():
-    def heat_balance(conductor_temperature, current):
-        A = current
-        T = conductor_temperature
-        return (A - 100 * T) * (current + 100 * T)
-
+def test_compute_conductor_ampacity_computes_correct_ampacity(
+    heat_balance: Callable[[Celsius, Ampere], WattPerMeter],
+):
     conductor_temperature = solver.compute_conductor_ampacity(
         heat_balance,
         max_conductor_temperature=90,
@@ -34,9 +32,9 @@ def test_compute_conductor_ampacity_computes_correct_ampacity():
 
 def test_bisect_raises_value_error():
     def heat_balance(current):
-        A = current
+        I = current  # noqa: E741
         T = 90
-        return (A + 100 * T) * (A + 100 * T)
+        return (I + 100 * T) * (I + 100 * T)
 
     with pytest.raises(ValueError):
         solver.bisect(
@@ -47,15 +45,13 @@ def test_bisect_raises_value_error():
         )
 
 
-def test_bisect_handles_function_returning_array_happy_path():
-    def heat_balance(currents: np.array):
-        A = currents
-        T = 90
-        res = (A - 100 * T) * (currents + 100 * T)
-        return res
+def test_bisect_handles_function_returning_array_happy_path(
+    heat_balance: Callable[[Celsius, Ampere], WattPerMeter],
+):
+    _heat_balance = partial(heat_balance, 90)
 
     solution = solver.bisect(
-        heat_balance,
+        _heat_balance,
         xmin=np.array([0, 0]),
         xmax=np.array([10_000, 10_000]),
         tolerance=1e-8,
@@ -63,16 +59,13 @@ def test_bisect_handles_function_returning_array_happy_path():
     np.testing.assert_array_almost_equal(solution, [9_000, 9_000], decimal=8)
 
 
-def test_bisect_raises_valueerror_when_same_sign_for_array_input():
-    def heat_balance(currents: np.array):
-        A = currents
-        T = 90
-        res = (A - 100 * T) * (currents + 100 * T)
-        return res
-
+def test_bisect_raises_valueerror_when_same_sign_for_array_input(
+    heat_balance: Callable[[Celsius, Ampere], WattPerMeter],
+):
+    _heat_balance = partial(heat_balance, 90)
     with pytest.raises(ValueError):
         solver.bisect(
-            heat_balance,
+            _heat_balance,
             xmin=np.array([0, 0]),
             xmax=np.array([10_000, 8_000]),
             tolerance=1e-8,
@@ -89,27 +82,26 @@ def test_bisect_raises_valueerror_when_infinite_in_array_input():
         )
 
 
-def test_bisect_returns_dtype_float_if_invalid_value_is_none():
-    def heat_balance(currents: np.array):
-        A = currents
-        T = 90
-        res = (A - 100 * T) * (currents + 100 * T)
-        return res
+def test_bisect_returns_dtype_float_if_not_accept_invalid_values(
+    heat_balance: Callable[[Celsius, Ampere], WattPerMeter],
+):
+    _heat_balance = partial(heat_balance, 90)
 
     solution = solver.bisect(
-        heat_balance,
+        _heat_balance,
         xmin=np.array([0, 0]),
         xmax=np.array([10_000, 10_000]),
         tolerance=1e-8,
-        invalid_value=None,
+        accept_invalid_values=False,
     )
 
+    assert isinstance(solution, np.ndarray)
     assert solution.dtype == np.float64
 
 
 def test_bisect_return_nan_if_heat_balance_returns_nan():
-    def heat_balance(currents: np.array):
-        return np.ones_like(currents) * np.nan
+    def heat_balance(current: Ampere) -> WattPerMeter:
+        return np.ones_like(current) * np.nan
 
     solution = solver.bisect(
         heat_balance,

{linerate-2.1.3 → linerate-2.2.1}/uv.lock

@@ -1,5 +1,5 @@
 version = 1
-revision = 3
+revision = 2
 requires-python = ">=3.9"
 resolution-markers = [
     "python_full_version >= '3.12'",
@@ -842,7 +842,10 @@ dependencies = [
 dev = [
     { name = "coverage", extra = ["toml"] },
     { name = "hypothesis" },
+    { name = "matplotlib", version = "3.9.4", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.10'" },
+    { name = "matplotlib", version = "3.10.1", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.10'" },
     { name = "pre-commit" },
+    { name = "pyright", extra = ["nodejs"] },
     { name = "pytest" },
     { name = "pytest-cov" },
     { name = "pytest-randomly" },
@@ -871,7 +874,9 @@ requires-dist = [
 dev = [
     { name = "coverage", extras = ["toml"] },
     { name = "hypothesis", specifier = ">=6.56.2" },
+    { name = "matplotlib", specifier = ">=3.9.4" },
     { name = "pre-commit" },
+    { name = "pyright", extras = ["nodejs"] },
     { name = "pytest", specifier = "==8.4.2" },
     { name = "pytest-cov", specifier = "==7.0.0" },
     { name = "pytest-randomly", specifier = "==4.0.1" },
@@ -1146,6 +1151,22 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/d2/1d/1b658dbd2b9fa9c4c9f32accbfc0205d532c8c6194dc0f2a4c0428e7128a/nodeenv-1.9.1-py2.py3-none-any.whl", hash = "sha256:ba11c9782d29c27c70ffbdda2d7415098754709be8a7056d79a737cd901155c9", size = 22314, upload-time = "2024-06-04T18:44:08.352Z" },
 ]
 
+[[package]]
+name = "nodejs-wheel-binaries"
+version = "24.13.0"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/b7/f1/73182280e2c05f49a7c2c8dbd46144efe3f74f03f798fb90da67b4a93bbf/nodejs_wheel_binaries-24.13.0.tar.gz", hash = "sha256:766aed076e900061b83d3e76ad48bfec32a035ef0d41bd09c55e832eb93ef7a4", size = 8056, upload-time = "2026-01-14T11:05:33.653Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/c4/dc/4d7548aa74a5b446d093f03aff4fb236b570959d793f21c9c42ab6ad870a/nodejs_wheel_binaries-24.13.0-py2.py3-none-macosx_13_0_arm64.whl", hash = "sha256:356654baa37bfd894e447e7e00268db403ea1d223863963459a0fbcaaa1d9d48", size = 55133268, upload-time = "2026-01-14T11:05:05.335Z" },
+    { url = "https://files.pythonhosted.org/packages/24/8a/8a4454d28339487240dd2232f42f1090e4a58544c581792d427f6239798c/nodejs_wheel_binaries-24.13.0-py2.py3-none-macosx_13_0_x86_64.whl", hash = "sha256:92fdef7376120e575f8b397789bafcb13bbd22a1b4d21b060d200b14910f22a5", size = 55314800, upload-time = "2026-01-14T11:05:09.121Z" },
+    { url = "https://files.pythonhosted.org/packages/e7/fb/46c600fcc748bd13bc536a735f11532a003b14f5c4dfd6865f5911672175/nodejs_wheel_binaries-24.13.0-py2.py3-none-manylinux_2_28_aarch64.whl", hash = "sha256:3f619ac140e039ecd25f2f71d6e83ad1414017a24608531851b7c31dc140cdfd", size = 59666320, upload-time = "2026-01-14T11:05:12.369Z" },
+    { url = "https://files.pythonhosted.org/packages/85/47/d48f11fc5d1541ace5d806c62a45738a1db9ce33e85a06fe4cd3d9ce83f6/nodejs_wheel_binaries-24.13.0-py2.py3-none-manylinux_2_28_x86_64.whl", hash = "sha256:dfb31ebc2c129538192ddb5bedd3d63d6de5d271437cd39ea26bf3fe229ba430", size = 60162447, upload-time = "2026-01-14T11:05:16.003Z" },
+    { url = "https://files.pythonhosted.org/packages/b1/74/d285c579ae8157c925b577dde429543963b845e69cd006549e062d1cf5b6/nodejs_wheel_binaries-24.13.0-py2.py3-none-musllinux_1_2_aarch64.whl", hash = "sha256:fdd720d7b378d5bb9b2710457bbc880d4c4d1270a94f13fbe257198ac707f358", size = 61659994, upload-time = "2026-01-14T11:05:19.68Z" },
+    { url = "https://files.pythonhosted.org/packages/ba/97/88b4254a2ff93ed2eaed725f77b7d3d2d8d7973bf134359ce786db894faf/nodejs_wheel_binaries-24.13.0-py2.py3-none-musllinux_1_2_x86_64.whl", hash = "sha256:9ad6383613f3485a75b054647a09f1cd56d12380d7459184eebcf4a5d403f35c", size = 62244373, upload-time = "2026-01-14T11:05:23.987Z" },
+    { url = "https://files.pythonhosted.org/packages/4e/c3/0e13a3da78f08cb58650971a6957ac7bfef84164b405176e53ab1e3584e2/nodejs_wheel_binaries-24.13.0-py2.py3-none-win_amd64.whl", hash = "sha256:605be4763e3ef427a3385a55da5a1bcf0a659aa2716eebbf23f332926d7e5f23", size = 41345528, upload-time = "2026-01-14T11:05:27.67Z" },
+    { url = "https://files.pythonhosted.org/packages/a3/f1/0578d65b4e3dc572967fd702221ea1f42e1e60accfb6b0dd8d8f15410139/nodejs_wheel_binaries-24.13.0-py2.py3-none-win_arm64.whl", hash = "sha256:2e3431d869d6b2dbeef1d469ad0090babbdcc8baaa72c01dd3cc2c6121c96af5", size = 39054688, upload-time = "2026-01-14T11:05:30.739Z" },
+]
+
 [[package]]
 name = "numba"
 version = "0.60.0"
@@ -1545,6 +1566,24 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/05/e7/df2285f3d08fee213f2d041540fa4fc9ca6c2d44cf36d3a035bf2a8d2bcc/pyparsing-3.2.3-py3-none-any.whl", hash = "sha256:a749938e02d6fd0b59b356ca504a24982314bb090c383e3cf201c95ef7e2bfcf", size = 111120, upload-time = "2025-03-25T05:01:24.908Z" },
 ]
 
+[[package]]
+name = "pyright"
+version = "1.1.408"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "nodeenv" },
+    { name = "typing-extensions" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/74/b2/5db700e52554b8f025faa9c3c624c59f1f6c8841ba81ab97641b54322f16/pyright-1.1.408.tar.gz", hash = "sha256:f28f2321f96852fa50b5829ea492f6adb0e6954568d1caa3f3af3a5f555eb684", size = 4400578, upload-time = "2026-01-08T08:07:38.795Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/0c/82/a2c93e32800940d9573fb28c346772a14778b84ba7524e691b324620ab89/pyright-1.1.408-py3-none-any.whl", hash = "sha256:090b32865f4fdb1e0e6cd82bf5618480d48eecd2eb2e70f960982a3d9a4c17c1", size = 6399144, upload-time = "2026-01-08T08:07:37.082Z" },
+]
+
+[package.optional-dependencies]
+nodejs = [
+    { name = "nodejs-wheel-binaries" },
+]
+
 [[package]]
 name = "pytest"
 version = "8.4.2"