Feeature/#28/transient temperature time depending parameter

examples/create_env

@@ -5,7 +5,7 @@ ENV_DIR=/home/${USER}/ENV
 mkdir -p $ENV_DIR
 
 # -- current env with link
-VENV=${ENV_DIR}/thermohl
+VENV=${ENV_DIR}/ecieren-thermohl
 VLNK=.venv
 ln -sf $VENV $VLNK
 python3 -m venv $VENV

sonar-project.properties

@@ -13,4 +13,4 @@ sonar.sources=src/
 sonar.tests=test/
 
 sonar.python.version=3.9,3.10,3.11
-sonar.python.coverage.reportPaths=coverage.xml
+sonar.python.coverage.reportPaths=coverage.xml

src/thermohl/power/__init__.py

@@ -5,7 +5,6 @@
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 # SPDX-License-Identifier: MPL-2.0
 
-from .radiative_cooling import RadiativeCoolingBase
-
 from .power_term import PowerTerm
+from .radiative_cooling import RadiativeCoolingBase
 from .solar_heating import _SRad, SolarHeatingBase

src/thermohl/power/cigre/__init__.py

@@ -12,7 +12,7 @@
 """
 
 from .air import Air
-from .solar_heating import SolarHeating
 from .convective_cooling import ConvectiveCooling
 from .joule_heating import JouleHeating
 from .radiative_cooling import RadiativeCooling
+from .solar_heating import SolarHeating

src/thermohl/power/cigre/solar_heating.py

@@ -48,7 +48,7 @@ def __init__(
         hour: floatArrayLike,
         D: floatArrayLike,
         alpha: floatArrayLike,
-        srad: Optional[floatArrayLike] = None,
+        srad: Optional[floatArrayLike] = float("nan"),
         **kwargs: Any,
     ):
         r"""Init with args.
@@ -74,8 +74,9 @@ def __init__(
             external diameter.
         alpha : float or np.ndarray
             Solar absorption coefficient.
-        srad : xxx
-            xxx.
+        srad : float or np.ndarray
+            Solar irradiance. Default is nan. If nan value is estimated using
+            all other input.
 
 
         Returns
@@ -85,7 +86,7 @@ def __init__(
 
         """
         self.alpha = alpha
-        if srad is None:
+        if np.all(np.isnan(srad)):
             self.srad = SolarHeating._solar_radiation(
                 np.deg2rad(lat), np.deg2rad(azm), al, month, day, hour
             )

src/thermohl/power/ieee/__init__.py

@@ -13,7 +13,6 @@
 
 from .air import Air
 from .convective_cooling import ConvectiveCooling
-from ..convective_cooling import ConvectiveCoolingBase
 from .joule_heating import JouleHeating
 from .radiative_cooling import RadiativeCooling
 from .solar_heating import SolarHeating

src/thermohl/power/ieee/convective_cooling.py

@@ -7,7 +7,6 @@
 
 from typing import Any
 
-
 from thermohl import floatArrayLike
 from thermohl.power.convective_cooling import ConvectiveCoolingBase
 from thermohl.power.ieee import Air

src/thermohl/power/ieee/solar_heating.py

@@ -7,7 +7,6 @@
 
 from typing import Optional, Any
 
-
 from thermohl import floatArrayLike, intArrayLike
 from thermohl.power import _SRad, SolarHeatingBase
 
@@ -24,7 +23,7 @@ def __init__(
         hour: floatArrayLike,
         D: floatArrayLike,
         alpha: floatArrayLike,
-        srad: Optional[floatArrayLike] = None,
+        srad: Optional[floatArrayLike] = float("nan"),
         **kwargs: Any,
     ):
         r"""Init with args.
@@ -52,8 +51,9 @@ def __init__(
             external diameter.
         alpha : float or np.ndarray
             Solar absorption coefficient.
-        srad : xxx
-            xxx
+        srad : float or np.ndarray
+            Solar irradiance. Default is nan. If nan value is estimated using
+            all other input.
 
         Returns
         -------

src/thermohl/power/olla/__init__.py

@@ -5,11 +5,10 @@
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 # SPDX-License-Identifier: MPL-2.0
 
-"""Power terms implementation using RTE's olla project choices.
-"""
+"""Power terms implementation using RTE's olla project choices."""
 
 from .air import Air
-from .solar_heating import SolarHeating
 from .convective_cooling import ConvectiveCooling
 from .joule_heating import JouleHeating
 from .radiative_cooling import RadiativeCooling
+from .solar_heating import SolarHeating

src/thermohl/power/olla/solar_heating.py

@@ -7,8 +7,8 @@
 
 from typing import Optional, Any
 
-from thermohl.power import ieee
 from thermohl import floatArrayLike, intArrayLike
+from thermohl.power import ieee
 
 
 class SolarHeating(ieee.SolarHeating):
@@ -24,7 +24,7 @@ def __init__(
         hour: floatArrayLike,
         D: floatArrayLike,
         alpha: floatArrayLike,
-        srad: Optional[floatArrayLike] = None,
+        srad: Optional[floatArrayLike] = float("nan"),
         **kwargs: Any,
     ):
         r"""Init with args.
@@ -38,7 +38,7 @@ def __init__(
         lat : float or np.ndarray
             Latitude.
         alt : float or np.ndarray
-             Lltitude.
+             Longitude.
         azm : float or np.ndarray
             Azimuth.
         month : int or np.ndarray
@@ -52,8 +52,9 @@ def __init__(
             external diameter.
         alpha : float or np.ndarray
             Solar absorption coefficient.
-        srad : xxx
-            xxx
+        srad : float or np.ndarray
+            Solar irradiance. Default is nan. If nan value is estimated using
+            all other input.
 
         Returns
         -------

src/thermohl/power/rte/__init__.py

@@ -5,8 +5,7 @@
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 # SPDX-License-Identifier: MPL-2.0
 
-"""Power terms implementation matching rte's Excel sheet.
-"""
+"""Power terms implementation matching rte's Excel sheet."""
 
 from .air import Air
 from .solar_heating import SolarHeating, solar_irradiance

src/thermohl/power/rte/convective_cooling.py

@@ -10,8 +10,8 @@
 import numpy as np
 
 from thermohl import floatArrayLike
-from thermohl.power.rte import Air
 from thermohl.power.convective_cooling import ConvectiveCoolingBase
+from thermohl.power.rte import Air
 
 
 class ConvectiveCooling(ConvectiveCoolingBase):

src/thermohl/power/rte/solar_heating.py

@@ -66,7 +66,7 @@ def __init__(
         hour: floatArrayLike,
         D: floatArrayLike,
         alpha: floatArrayLike,
-        srad: Optional[floatArrayLike] = None,
+        srad: Optional[floatArrayLike] = float("nan"),
         **kwargs: Any,
     ):
         r"""Build with args.
@@ -90,8 +90,9 @@ def __init__(
             external diameter.
         alpha : np.ndarray
             Solar absorption coefficient.
-        srad : xxx
-            xxx
+        srad : float or np.ndarray
+            Solar irradiance. Default is nan. If nan value is estimated using
+            all other input.
 
         Returns
         -------

src/thermohl/power/solar_heating.py

@@ -92,11 +92,11 @@ def __init__(
         D: floatArrayLike,
         alpha: floatArrayLike,
         est: _SRad,
-        srad: Optional[floatArrayLike] = None,
+        srad: Optional[floatArrayLike] = float("nan"),
         **kwargs: Any,
     ):
         self.alpha = alpha
-        if srad is None:
+        if np.all(np.isnan(srad)):
             self.srad = est(np.deg2rad(lat), alt, np.deg2rad(azm), tb, month, day, hour)
         else:
             self.srad = np.maximum(srad, 0.0)

src/thermohl/solver/__init__.py

@@ -9,18 +9,19 @@
 
 from typing import Dict, Any, Optional, Union, Type
 
-from thermohl.power import cigre as cigrep
-from thermohl.power import rte as rtep
-from thermohl.power import ieee as ieeep
-from thermohl.power import olla as ollap
-
+from thermohl.power import cigre as _cigre
+from thermohl.power import ieee as _ieee
+from thermohl.power import olla as _olla
+from thermohl.power import rte as _rte
 from thermohl.solver.base import Args, Solver
 from thermohl.solver.slv1d import Solver1D
 from thermohl.solver.slv1t import Solver1T
 from thermohl.solver.slv3t import Solver3T
 from thermohl.solver.slv3t_legacy import Solver3TL
 
-concreteSolverType = Union[Type[Solver1T], Type[Solver3T], Type[Solver3TL], Type[Solver1D]]
+concreteSolverType = Union[
+    Type[Solver1T], Type[Solver3T], Type[Solver3TL], Type[Solver1D]
+]
 
 
 def default_values() -> Dict[str, Any]:
@@ -45,34 +46,34 @@ def _factory(
     if model == "cigre":
         return solver(
             dic,
-            cigrep.JouleHeating,
-            cigrep.SolarHeating,
-            cigrep.ConvectiveCooling,
-            cigrep.RadiativeCooling,
+            _cigre.JouleHeating,
+            _cigre.SolarHeating,
+            _cigre.ConvectiveCooling,
+            _cigre.RadiativeCooling,
         )
     elif model == "ieee":
         return solver(
             dic,
-            ieeep.JouleHeating,
-            ieeep.SolarHeating,
-            ieeep.ConvectiveCooling,
-            ieeep.RadiativeCooling,
+            _ieee.JouleHeating,
+            _ieee.SolarHeating,
+            _ieee.ConvectiveCooling,
+            _ieee.RadiativeCooling,
         )
     elif model == "olla":
         return solver(
             dic,
-            ollap.JouleHeating,
-            ollap.SolarHeating,
-            ollap.ConvectiveCooling,
-            ollap.RadiativeCooling,
+            _olla.JouleHeating,
+            _olla.SolarHeating,
+            _olla.ConvectiveCooling,
+            _olla.RadiativeCooling,
         )
     elif model == "rte":
         return solver(
             dic,
-            rtep.JouleHeating,
-            rtep.SolarHeating,
-            rtep.ConvectiveCooling,
-            rtep.RadiativeCooling,
+            _rte.JouleHeating,
+            _rte.SolarHeating,
+            _rte.ConvectiveCooling,
+            _rte.RadiativeCooling,
         )
     else:
         raise ValueError()