spelling and formating

Author: drunsinn

Makefile

@@ -3,6 +3,11 @@
 clean:
 	rm -rf build dist *.egg-info
 
+clear_cache:
+	rm -rf .pytest_cache
+	rm -rf .ruff_cache
+	uv run pyclean .
+
 test:
 	uv run pytest
 

pyXSteam/IAPWS_R14.py

@@ -46,7 +46,7 @@ def pmelt_T_iceIII(T: float) -> float:
 
 
 def Tmelt_p_iceIII(p: float) -> float:
-    """invers of `pmelt_T_iceIII`
+    """inverse of `pmelt_T_iceIII`
     :param T: melting preasure in [MPa]
 
     :return: temperature in [K]
@@ -73,7 +73,7 @@ def pmelt_T_iceV(T: float) -> float:
 
 
 def Tmelt_p_iceV(p: float) -> float:
-    """invers of `pmelt_T_iceV`
+    """inversee of `pmelt_T_iceV`
     :param T: melting preasure in [MPa]
 
     :return: temperature in [K]
@@ -99,7 +99,7 @@ def pmelt_T_iceVI(T: float) -> float:
 
 
 def Tmelt_p_iceVI(p: float) -> float:
-    """invers of `pmelt_T_iceVI`
+    """inversee of `pmelt_T_iceVI`
     :param T: melting preasure in [MPa]
 
     :return: temperature in [K]

pyXSteam/IAPWS_R4.py

@@ -12,7 +12,9 @@
 
 
 def myHW_rhoT(rho: float, T: float) -> float:
-    pass
+    """placeholder"""
+    raise DeprecationWarning("R4-84 was superseded by R17 and R18!")
+    return
 
 
 def myHW_rhoT_R4(rho: float, T: float) -> float:
@@ -25,7 +27,7 @@ def myHW_rhoT_R4(rho: float, T: float) -> float:
 
     :return: viscosity µ or NaN if arguments are out of range, in [Pa s]
     """
-    raise DeprecationWarning("R4-84 was superseded by R17 and R18!")
+    logger.warning("R4-84 was superseded by R17 and R18!")
     logger.debug("calculating 'viscosity of heavy water' for ρ=%f and T=%f", rho, T)
 
     T_star = 643.847  # K
@@ -83,7 +85,7 @@ def tcHW_rhoT_R4(rho: float, T: float) -> float:
 
     :return: thermal conductivity λ or NaN, in [W / (m * K)]
     """
-    raise DeprecationWarning("R4-84 was superseded by R17 and R18!")
+    logger.warning("R4-84 was superseded by R17 and R18!")
     logger.debug("calculating 'thermal conductivity of heavy water' for ρ=%f and T=%f", rho, T)
 
     T_star = 643.847  # K

pyXSteam/IAPWS_R6.py

@@ -13,13 +13,13 @@
 
 logger = logging.getLogger(__name__)
 
-# TODO: make functions availible via XSteam
-# TODO: verify functions R6_* for which no test values are availible in R6
+# TODO: make functions available via XSteam
+# TODO: verify functions R6_* for which no test values are available in R6
 # TODO: add missing tests
 
 
 def eq_Theta(tau: float, delta: float, A: float, beta: float) -> float:
-    """line 2 of eq 6 or table 5 - function not to be used seperatly
+    """line 2 of eq 6 or table 5 - function not to be used separately
 
     :param tau: temperature coefficient τ
     :param delta: density coefficient δ
@@ -32,7 +32,7 @@ def eq_Theta(tau: float, delta: float, A: float, beta: float) -> float:
 
 
 def eq_Delta(tau: float, delta: float, a: float, A: float, B: float, beta: float) -> float:
-    """line 1 of eq 6 or table 5 - function not to be used seperatly
+    """line 1 of eq 6 or table 5 - function not to be used separately
 
     :param tau: temperature coefficient τ
     :param delta: density coefficient δ
@@ -48,7 +48,7 @@ def eq_Delta(tau: float, delta: float, a: float, A: float, B: float, beta: float
 
 
 def eq_Psi(tau: float, delta: float, C: float, D: float) -> float:
-    """line 3 of eq 6 or table 5 - function not to be used seperatly
+    """line 3 of eq 6 or table 5 - function not to be used separately
 
     :param tau: temperature coefficient τ
     :param delta: density coefficient δ
@@ -61,7 +61,7 @@ def eq_Psi(tau: float, delta: float, C: float, D: float) -> float:
 
 
 def eq_dDelta_ddelta(tau: float, delta: float, a: float, A: float, B: float, beta: float) -> float:
-    """line 6 in table 5 continued - function not to be used seperatly
+    """line 6 in table 5 continued - function not to be used separately
     Derivatives of the distance function ∆
 
     :param tau: temperature coefficient τ
@@ -80,7 +80,7 @@ def eq_dDelta_ddelta(tau: float, delta: float, a: float, A: float, B: float, bet
 
 
 def eq_ddDelta_ddeltadelta(tau: float, delta: float, a: float, A: float, B: float, beta: float):
-    """line 7 in table 5 continued - function not to be used seperatly
+    """line 7 in table 5 continued - function not to be used separately
     Derivatives of the distance function ∆
 
     :param tau: temperature coefficient τ
@@ -102,7 +102,7 @@ def eq_ddDelta_ddeltadelta(tau: float, delta: float, a: float, A: float, B: floa
 
 
 def eq_dDelta_b_ddelta(tau: float, delta: float, a: float, b: float, A: float, B: float, beta: float) -> float:
-    """line 1 of table 5 continued - function not to be used seperatly
+    """line 1 of table 5 continued - function not to be used separately
     Derivatives of the distance function ∆^b
 
     :param tau: temperature coefficient τ
@@ -121,7 +121,7 @@ def eq_dDelta_b_ddelta(tau: float, delta: float, a: float, b: float, A: float, B
 
 
 def eq_ddDelta_b_ddeltadelta(tau: float, delta: float, a: float, b: float, A: float, B: float, beta: float) -> float:
-    """line 2 in table 5 continued - function not to be used seperatly
+    """line 2 in table 5 continued - function not to be used separately
     Derivatives of the distance function ∆^b
 
     :param tau: temperature coefficient τ
@@ -141,7 +141,7 @@ def eq_ddDelta_b_ddeltadelta(tau: float, delta: float, a: float, b: float, A: fl
 
 
 def eq_dDelta_b_dtau(tau: float, delta: float, a: float, b: float, A: float, B: float, beta: float) -> float:
-    """line 3 in table 5 continued - function not to be used seperatly
+    """line 3 in table 5 continued - function not to be used separately
     Derivatives of the distance function ∆^b
 
     :param tau: temperature coefficient τ
@@ -160,7 +160,7 @@ def eq_dDelta_b_dtau(tau: float, delta: float, a: float, b: float, A: float, B:
 
 
 def eq_ddDelta_b_dtautau(tau: float, delta: float, a: float, b: float, A: float, B: float, beta: float) -> float:
-    """line 4 of table 5 continued - function not to be used seperatly
+    """line 4 of table 5 continued - function not to be used separately
     Derivatives of the distance function ∆^b
 
     :param tau: temperature coefficient τ
@@ -179,7 +179,7 @@ def eq_ddDelta_b_dtautau(tau: float, delta: float, a: float, b: float, A: float,
 
 
 def eq_ddDelta_b_ddeltadtau(tau: float, delta: float, a: float, b: float, A: float, B: float, beta: float) -> float:
-    """line 5 of table 5 continued - function not to be used seperatly
+    """line 5 of table 5 continued - function not to be used separately
     Derivatives of the distance function ∆^b
 
     :param tau: temperature coefficient τ
@@ -202,7 +202,7 @@ def eq_ddDelta_b_ddeltadtau(tau: float, delta: float, a: float, b: float, A: flo
 
 
 def eq_dPsi_ddelta(tau: float, delta: float, C: float, D: float) -> float:
-    """line 1 in column 2 of table 5 continued - function not to be used seperatly
+    """line 1 in column 2 of table 5 continued - function not to be used separately
     Derivatives of the exponential function ψ
 
     :param tau: temperature coefficient τ
@@ -217,7 +217,7 @@ def eq_dPsi_ddelta(tau: float, delta: float, C: float, D: float) -> float:
 
 
 def eq_ddPsi_ddeltadelta(tau: float, delta: float, C: float, D: float) -> float:
-    """line 2 in column 2 of table 5 continued - function not to be used seperatly
+    """line 2 in column 2 of table 5 continued - function not to be used separately
     Derivatives of the exponential function ψ
 
     :param tau: temperature coefficient τ
@@ -232,7 +232,7 @@ def eq_ddPsi_ddeltadelta(tau: float, delta: float, C: float, D: float) -> float:
 
 
 def eq_dPsi_dtau(tau: float, delta: float, C: float, D: float) -> float:
-    """line 3 in column 2 of table 5 continued - function not to be used seperatly
+    """line 3 in column 2 of table 5 continued - function not to be used separately
     Derivatives of the exponential function ψ
 
     :param tau: temperature coefficient τ
@@ -247,7 +247,7 @@ def eq_dPsi_dtau(tau: float, delta: float, C: float, D: float) -> float:
 
 
 def eq_ddPsi_dtautau(tau: float, delta: float, C: float, D: float) -> float:
-    """line 4 in column 2 of table 5 continued - function not to be used seperatly
+    """line 4 in column 2 of table 5 continued - function not to be used separately
     Derivatives of the exponential function ψ
 
     :param tau: temperature coefficient τ
@@ -262,7 +262,7 @@ def eq_ddPsi_dtautau(tau: float, delta: float, C: float, D: float) -> float:
 
 
 def eq_ddPsi_ddeltadtau(tau: float, delta: float, C: float, D: float) -> float:
-    """line 5 in column 2 of table 5 continued - function not to be used seperatly
+    """line 5 in column 2 of table 5 continued - function not to be used separately
     Derivatives of the exponential function ψ
 
     :param tau: temperature coefficient τ
@@ -277,7 +277,7 @@ def eq_ddPsi_ddeltadtau(tau: float, delta: float, C: float, D: float) -> float:
 
 
 def eq_phi_o(tau: float, delta: float) -> float:
-    """Ep 5 or line 1 in table 4 - function not to be used seperatly
+    """Ep 5 or line 1 in table 4 - function not to be used separately
     The ideal-gas part φo of the dimensionless Helmholtz free energy
 
     :param tau: temperature coefficient τ
@@ -295,7 +295,7 @@ def eq_phi_o(tau: float, delta: float) -> float:
 
 
 def eq_phi_o_delta(delta: float) -> float:
-    """line 2 in table 4 - function not to be used seperatly
+    """line 2 in table 4 - function not to be used separately
     The ideal-gas part φo of the dimensionless Helmholtz free energy
 
     :param delta: density coefficient δ
@@ -306,7 +306,7 @@ def eq_phi_o_delta(delta: float) -> float:
 
 
 def eq_phi_o_deltadelta(delta: float) -> float:
-    """line 3 in table 4 - function not to be used seperatly
+    """line 3 in table 4 - function not to be used separately
     The ideal-gas part φo of the dimensionless Helmholtz free energy
 
     :param delta: density coefficient δ
@@ -317,7 +317,7 @@ def eq_phi_o_deltadelta(delta: float) -> float:
 
 
 def eq_phi_o_tau(tau: float) -> float:
-    """line 5 in table 4 - function not to be used seperatly
+    """line 5 in table 4 - function not to be used separately
     The ideal-gas part φo of the dimensionless Helmholtz free energy
 
     :param tau: temperature coefficient τ
@@ -332,7 +332,7 @@ def eq_phi_o_tau(tau: float) -> float:
 
 
 def eq_phi_o_tautau(tau: float) -> float:
-    """line 6 in table 4 - function not to be used seperatly
+    """line 6 in table 4 - function not to be used separately
     The ideal-gas part φo of the dimensionless Helmholtz free energy
 
     :param tau: temperature coefficient τ
@@ -348,7 +348,7 @@ def eq_phi_o_tautau(tau: float) -> float:
 
 
 def eq_phi_o_deltatau() -> float:
-    """Table 4, Eq 6 - function not to be used seperatly
+    """Table 4, Eq 6 - function not to be used separately
     The ideal-gas part φo of the dimensionless Helmholtz free energy
 
     :return: φ^o_δτ
@@ -357,7 +357,7 @@ def eq_phi_o_deltatau() -> float:
 
 
 def eq_phi_r(tau: float, delta: float) -> float:
-    """Eq 6 or line 1 in table 5 - function not to be used seperatly
+    """Eq 6 or line 1 in table 5 - function not to be used separately
     The residual part φr of the dimensionless Helmholtz free energy
 
     :param tau: temperature coefficient τ
@@ -389,7 +389,7 @@ def _exp(tau, delta, alpha, beta, gamma, epsilon) -> float:
 
 
 def eq_phi_r_delta(tau: float, delta: float) -> float:
-    """line 2 in table 5 - function not to be used seperatly
+    """line 2 in table 5 - function not to be used separately
     The residual part φr of the dimensionless Helmholtz free energy
 
     :param tau: temperature coefficient τ
@@ -420,7 +420,7 @@ def eq_phi_r_delta(tau: float, delta: float) -> float:
 
 
 def eq_phi_r_deltadelta(tau: float, delta: float) -> float:
-    """line 3 in table 5 - function not to be used seperatly
+    """line 3 in table 5 - function not to be used separately
     The residual part φr of the dimensionless Helmholtz free energy
 
     :param tau: temperature coefficient τ
@@ -469,7 +469,7 @@ def eq_phi_r_deltadelta(tau: float, delta: float) -> float:
 
 
 def eq_phi_r_tau(tau: float, delta: float) -> float:
-    """line 4 in table 5 - function not to be used seperatly
+    """line 4 in table 5 - function not to be used separately
     The residual part φr of the dimensionless Helmholtz free energy
 
     :param tau: temperature coefficient τ
@@ -501,7 +501,7 @@ def eq_phi_r_tau(tau: float, delta: float) -> float:
 
 
 def eq_phi_r_tautau(tau: float, delta: float) -> float:
-    """line 5 in table 5 - function not to be used seperatly
+    """line 5 in table 5 - function not to be used separately
     The residual part φr of the dimensionless Helmholtz free energy
 
     :param tau: temperature coefficient τ
@@ -540,7 +540,7 @@ def eq_phi_r_tautau(tau: float, delta: float) -> float:
 
 
 def eq_phi_r_deltatau(tau: float, delta: float) -> float:
-    """line 6 in table 5 - function not to be used seperatly
+    """line 6 in table 5 - function not to be used separately
     The residual part φr of the dimensionless Helmholtz free energy
 
     :param tau: temperature coefficient τ

pyXSteam/XSteam.py

@@ -39,7 +39,7 @@
     pmelt_T_iceVII,
     psubl_T,
 )
-from .IAPWS_R12 import eq10
+from .IAPWS_R12 import my_rhoT
 
 
 class XSteam:
@@ -2373,24 +2373,24 @@ def psubl_t(self, t: float) -> float:
         self.logger.warning("temperature %f out of range", T)
         return float("NaN")
 
-    def R12_my_rhot(self, rho: float, t: float, industrial_application: bool = True) -> float:
-        """shear viscosity of pure water substance over an extensive range of fluid states
+    # def R12_my_rhot(self, rho: float, t: float, industrial_application: bool = True) -> float:
+    #     """shear viscosity of pure water substance over an extensive range of fluid states
 
-        Release on the IAPWS Formulation 2008 for the Viscosity of Ordinary Water Substance
-        IAPWS R12-08
-        http://www.iapws.org/relguide/visc.pdf
+    #     Release on the IAPWS Formulation 2008 for the Viscosity of Ordinary Water Substance
+    #     IAPWS R12-08
+    #     http://www.iapws.org/relguide/visc.pdf
 
-        :param rho: density
-        :param t: temperature
-        :param industrial_application: select if simple or detailes approximation should be used
+    #     :param rho: density
+    #     :param t: temperature
+    #     :param industrial_application: select if simple or detailes approximation should be used
 
-        :return: shear viscosity
-        """
-        self.logger.warning("this function is still experimental, use at your own risk!")
+    #     :return: shear viscosity
+    #     """
+    #     self.logger.warning("this function is still experimental, use at your own risk!")
 
-        T = self._unit_converter.toSIunit_T(t)
+    #     T = self._unit_converter.toSIunit_T(t)
 
-        my_my = eq10(T, rho, industrial=industrial_application)
-        my = my_my * 10e5
+    #     my_my = my_rhoT(rho, T)
+    #     my = my_my * 10e5
 
-        return self._unit_converter.fromSIunit_my(my)
+    #     return self._unit_converter.fromSIunit_my(my)

pyXSteam/tables/R14_08.py

@@ -5,7 +5,7 @@
 
 Sources:
 
-* IAPWS R14-08(2011) Revised Release on the Pressure along the Melting 
+* IAPWS R14-08(2011) Revised Release on the Pressure along the Melting
 and Sublimation Curves of Ordinary Water Substance
 
 """

pyXSteam/tables/SR2_01.py

@@ -6,8 +6,8 @@
 Sources:
 
 * IAPWS SR2-01(2014) Revised Supplementary Release on Backward Equations for
-Pressure as a Function of Enthalpy and Entropy p(h,s) for Regions 1 and 2 of 
-the IAPWS Industrial Formulation 1997 for the Thermodynamic Properties of 
+Pressure as a Function of Enthalpy and Entropy p(h,s) for Regions 1 and 2 of
+the IAPWS Industrial Formulation 1997 for the Thermodynamic Properties of
 Water and Steam
 
 """

pyXSteam/tables/SR3_03.py

@@ -5,7 +5,7 @@
 
 Sources:
 
-* IAPWS SR3-03(2014) Revised Supplementary Release on Backward Equations for 
+* IAPWS SR3-03(2014) Revised Supplementary Release on Backward Equations for
 the Functions T(p,h), v(p,h) and T(p,s), v(p,s) for Region 3 of the IAPWS Industrial
 Formulation 1997 for the Thermodynamic Properties of Water and Steam