ubc-solar-physics 1.2.0__cp311-cp311-win_amd64.whl → 1.4.0__cp311-cp311-win_amd64.whl

physics/_version.py

@@ -1,8 +1,13 @@
-# file generated by setuptools_scm
+# file generated by setuptools-scm
 # don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
 TYPE_CHECKING = False
 if TYPE_CHECKING:
-    from typing import Tuple, Union
+    from typing import Tuple
+    from typing import Union
+
     VERSION_TUPLE = Tuple[Union[int, str], ...]
 else:
     VERSION_TUPLE = object
@@ -12,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.2.0'
-__version_tuple__ = version_tuple = (1, 2, 0)
+__version__ = version = '1.4.0'
+__version_tuple__ = version_tuple = (1, 4, 0)

physics/models/battery/battery_config.toml

@@ -0,0 +1,8 @@
+R_0_data = [0.002564, 0.002541, 0.002541, 0.002558, 0.002549, 0.002574, 0.002596, 0.002626, 0.002676, 0.002789]
+R_P = 0.000530
+C_P = 14646         
+Q_total = 259200
+SOC_data = [0.0752, 0.1705, 0.2677, 0.366, 0.4654, 0.5666, 0.6701, 0.7767, 0.8865, 1.0]
+Uoc_data = [3.481, 3.557, 3.597, 3.623, 3.660, 3.750, 3.846, 3.946, 4.056, 4.183]
+max_current_capacity = 40
+max_energy_capacity = 500

physics/models/battery/kalman_filter.py

@@ -178,3 +178,164 @@ def check_Terminal_V(Ut):
         raise TypeError(f"Invalid type for measured_Ut: {type(Ut)}. Expected float or int.")
     if not (0.0 <= Ut <= 5.0):
         raise ValueError(f"Invalid value for terminal voltage (measured_Ut): {Ut}. Must be between 0.0 and 5.0 volts.")
+
+import numpy as np
+from filterpy.kalman import ExtendedKalmanFilter as EKF
+from physics.models.battery.battery_config import BatteryModelConfig
+import numpy as np
+
+class EKF_SOC():
+    def __init__(self, battery_config: BatteryModelConfig,  initial_SOC = 1, initial_Uc = 0):
+        """
+        EKF_SOC represents the kalman filter used for predicting state of charge.
+
+        Attributes:
+            battery_model_config (BatteryModelConfig): This contains the HPPC parameters of the battery model
+            initial_SOC (float/int): Ranges from 0 to 1 inclusive. The initial state of charge of the battery.
+            initial_Uc (float/int):  The initial polarization volatge of the battery. (V)
+        """
+        # Inital state
+        self.SOC = initial_SOC
+        self.Uc = initial_Uc  # Polarization Volatge
+
+        # Covariance Matrices
+        self.Q_covariance = np.eye(2) * 0.0001
+        self.R_covariance = np.eye(1) * 0.5     # currently not really trusting the predicted state
+
+        # Load Config data
+        self.R_P = battery_config.R_P
+        self.C_P = battery_config.C_P
+        self.Q_total = battery_config.Q_total
+        SOC_data = np.array(battery_config.SOC_data)
+        Uoc_data = np.array(battery_config.Uoc_data)
+        R_0_data = np.array(battery_config.R_0_data)
+
+        # polynomial interpolation
+        self.Uoc_coefficients = np.polyfit(SOC_data, Uoc_data, 7)
+        self.R_0_coefficients = np.polyfit(SOC_data, R_0_data, 7)
+        self.Uoc_derivative_coefficients = np.polyder(self.Uoc_coefficients)
+
+        self.tau = self.R_P / self.C_P
+
+        # initializing the ekf object
+        self.ekf = EKF(dim_x=2, dim_z=1)
+        self.ekf.x = np.array([self.SOC, self.Uc])
+        self.ekf.P = np.diag([1e-6, 1e-6])  # I'm keeping low uncertainty in initial SOC and Uc
+        self.ekf.Q = self.Q_covariance
+        self.ekf.R = self.R_covariance
+
+        # For logs
+        self.predicted_measurment = 0
+    
+    def get_SOC(self): 
+        """ Return the state of charge of the battery """
+        return self.SOC
+    
+    def get_Uc(self):
+        """ Return the polarization voltage of the battery """
+        return self.Uc
+    
+    def get_predicted_Ut(self):
+        """ Return the predicted terminal voltage for the last prediction step """
+        return self.predicted_measurment
+        
+    def update_filter(self, measured_Ut, I):
+        """
+        Update the filter based on a new measurment, and the predicted state.
+        This function should be called after predict_state in a typical predict update workflow.
+
+        Attributes:
+            measured_Ut (float/integer): The actual voltage across the terminals of the battery.
+            I (float/integer): The current being sourced by the battery
+        """
+        check_Terminal_V(measured_Ut)
+
+        h_jacobian = self._measurement_jacobian
+        Hx = self._measurement_function
+
+        self.ekf.update(z=measured_Ut, HJacobian=h_jacobian, Hx=Hx, hx_args=I)
+
+        self.SOC, self.Uc = self.ekf.x
+
+    def predict_state(self, I, time_step):
+        """
+        Predicts the next evolution of the state vector (SOC, Uc).
+        This function should be called before updating the filter in a typical predict update workflow.
+
+        Attributes:
+            I (float/integer): The current being sourced by the battery. Positive indicated current being drawn.
+            time_step (float/integer): Time elapsed between this prediction and the last updated state of filter. (Seconds)
+        """        
+        check_current(I)
+        # Control matrix B (for input current I_k)
+        self.ekf.B = np.array([-time_step / self.Q_total, self.R_P * (1 - np.exp(-time_step / self.tau))])
+        self.ekf.F = self._state_jacobian(time_step)
+        
+        self.ekf.predict(u=I)
+        print(f'ekf prediction: {self.ekf.x_prior}')
+
+    def predict_then_update(self, measured_Ut, I, time_step):
+        """
+        Predicts the next evolution of the state vector (SOC, Uc), then updates the filter
+        based on this prediction and a measurement.
+        This function abstracts the full predict update workflow of the EKF. 
+
+        Attributes:
+            measured_Ut (float/integer): The actual voltage across the terminals of the battery.
+            I (float/integer): The current being sourced by the battery. Positive indicated current being drawn.
+            time_step (float/integer): Time elapsed between this prediction and the last updated state of filter. (Seconds)
+        """  
+        check_current(I)
+        check_Terminal_V(measured_Ut)
+
+        self.predict_state(I, time_step)
+        print(f'predicted: {self.ekf.x_prior}')
+
+        self.update_filter(measured_Ut, I)
+        print(f'SOC: {self.ekf.x[0]}, Uc: {self.ekf.x[1]}')
+
+    def _state_jacobian(self, time_step):
+        """ 
+        Returns the state jacobian for the current time 
+
+        Attributes:
+            time_step (float/integer): Time elapsed between this prediction and the last updated state of filter. (Seconds)
+        """
+        return np.array([[1, 0], [0, np.exp(-time_step / self.tau)]])
+
+    def _measurement_jacobian(self, x):
+        """ 
+        Returns the measurement jacobian for the current time 
+
+        Attributes:
+            x [float, float]: The state vector [SOC, Uc], where both values are floats or integers.
+        """
+        SOC = x[0]
+        derivative = np.polyval(self.Uoc_derivative_coefficients, SOC)
+        return np.array([[derivative, -1]])
+
+    def _measurement_function(self, x, I):
+        """
+        The customized measurement equation relating Ut to SOC and Uc
+
+        Attributes:
+            x [float, float]: The state vector [SOC, Uc], where both values are floats or integers.
+            I (float/integer): The current being sourced by the battery. Positive indicated current being drawn.
+        """
+        SOC, Uc = x
+        R_0 = np.polyval(self.R_0_coefficients, SOC)
+        Uoc = np.polyval(self.Uoc_coefficients, SOC)
+        self.predicted_measurment = Uoc - Uc - R_0*I
+        return self.predicted_measurment
+
+def check_current(I):
+    if not isinstance(I, (float, int)):
+        raise TypeError(f"Invalid type for current I: {type(I)}. Expected float or int.")
+    if not (-45.0 <= I <= 45.0):
+        raise ValueError(f"Invalid value for current (I): {I}. Must be between -45.0A and 45.0A.")
+
+def check_Terminal_V(Ut):
+    if not isinstance(Ut, (float, int)):
+        raise TypeError(f"Invalid type for measured_Ut: {type(Ut)}. Expected float or int.")
+    if not (0.0 <= Ut <= 5.0):
+        raise ValueError(f"Invalid value for terminal voltage (measured_Ut): {Ut}. Must be between 0.0 and 5.0 volts.")

physics/models/regen/basic_regen.py

@@ -12,6 +12,18 @@ class BasicRegen(BaseRegen):
         self.vehicle_mass = vehicle_mass
         self.kmh_to_mps = 0.278
 
+    def get_regen_efficiency(self, speed_array):
+        """
+        Returns a numpy array of regen efficiency percentage based on the vehicle speed in m/s.
+
+        :param speed_array: a numpy array of speeds in m/s
+        :returns: numpy array of regen efficiency percentage
+        """
+        # Efficiency polynomial, more details can be found in regen_analysis folder located in data_analysis
+        efficiency_poly = [0.022288416685942, 0.026545396753597]
+
+        return np.polyval(efficiency_poly, speed_array)
+
     def calculate_produced_energy(self, speed_kmh, gis_route_elevations, min_regen_speed, max_power):
         """
         Returns a numpy array containing the energy produced by regen
@@ -29,7 +41,8 @@ class BasicRegen(BaseRegen):
 
         # create regen energy produced array
         # if delta_energy is negative, we regen that energy back at the set efficiency rate; else 0 energy regen
-        produced_energy = np.where(delta_energy < 0, abs(delta_energy) * self.EFFICIENCY, 0)
+        efficiencies = self.get_regen_efficiency(speed_ms)
+        produced_energy = np.where(delta_energy < 0, abs(delta_energy) * efficiencies, 0)
 
         # Regen does not occur below a certain speed
         produced_energy = np.where(speed_ms >= min_regen_speed, produced_energy, 0)

{ubc_solar_physics-1.2.0.dist-info → ubc_solar_physics-1.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ubc-solar-physics
-Version: 1.2.0
+Version: 1.4.0
 Summary: UBC Solar's Simulation Environment
 Author: Fisher Xue, Mihir Nimgade, Chris Chang, David Widjaja, Justin Hua, Ilya Veksler, Renu Rajamagesh, Ritchie Xia, Erik Langille, Chris Aung, Nicolas Ric, Ishaan Trivedi, Jason Liang, Felix Toft, Mack Wilson, Jonah Lee, Tamzeed Quazi, Joshua Riefman
 Author-email: UBC Solar <strategy@ubcsolar.com>
@@ -42,7 +42,7 @@ License-File: LICENSE
 Requires-Dist: backports.tarfile==1.2.0
 Requires-Dist: certifi==2024.7.4
 Requires-Dist: charset-normalizer==3.3.2
-Requires-Dist: dill==0.3.8
+Requires-Dist: dill>=0.3.8
 Requires-Dist: haversine==2.8.1
 Requires-Dist: idna==3.7
 Requires-Dist: importlib_metadata==8.2.0

{ubc_solar_physics-1.2.0.dist-info → ubc_solar_physics-1.4.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
-core.cp311-win_amd64.pyd,sha256=WyxeKn8ggdsv_5r8z62OLFhDH1bKIlQW7iwmfKyytEA,382464
+core.cp311-win_amd64.pyd,sha256=gzsvsGUwCk5pL0ldFHYGQNZDfbX2F_xYdn3q4_GexbY,382464
 physics/__init__.py,sha256=jRV9J_eGh0vNXEfFrILqcM6xxVjyqm3XwKAg1B1IPBs,183
-physics/_version.py,sha256=DnUqy-xWN4z1XWOsowoRN4Vz2GPuDm_18GEJc3VGkWg,427
+physics/_version.py,sha256=mQpvfIn8roT-O8LS07P1pK-7O17jWuq_vL-TTh8VVvs,532
 physics/environment.rs,sha256=OghmBkvHLZvzzuVsXUmV2lR3X_tEwuB9sT2TGZLQC6E,36
 physics/lib.rs,sha256=FqnhKkotYKJCu8v1vbov2QW9s0apay7-BnEcUgxOakU,5798
 physics/models.rs,sha256=747ABP-D1XKxA6X_MNh1PbmST0zsxpxhP_pEWjbR46c,63
@@ -33,8 +33,9 @@ physics/models/battery/base_battery.py,sha256=yU-QopEEQ83kw4CUvJ2MEhYyj3AM3LYY_h
 physics/models/battery/basic_battery.py,sha256=5o-7g5xflhNLKuJyeqOY-1rLIOSIy_CJ0U4GEqeQO1E,5894
 physics/models/battery/battery.rs,sha256=0wIQVli7UOWgKXT96cQLWisLQKo5UE08X4B9dl09USI,3649
 physics/models/battery/battery_config.py,sha256=Dsi7cXR8SL0v7aSTuihhB6il9-8h1a2P8qrGbdvlf8Q,617
+physics/models/battery/battery_config.toml,sha256=J8jzmhg1mdfFqiHreiRfbbb_5byJklgVBEXKsn3sSUI,393
 physics/models/battery/battery_model.py,sha256=kHn-xOyFBzWycpd-9Wn75fzHYZ512wXOi1dUrlt3a5M,6313
-physics/models/battery/kalman_filter.py,sha256=Lr7J2vwO1HwN6miNFAYCfhZiZ2j72bwmUt-vubpo0Ks,7371
+physics/models/battery/kalman_filter.py,sha256=axDzXTpAmJVE_AcOv3nk8nhJJSztyaAwXQ6qC2Y0hj4,14231
 physics/models/lvs/__init__.py,sha256=ZBips6zW4Lot7SkQZMZt_OGRNUqgOfUlDtBA5lfUkM4,114
 physics/models/lvs/base_lvs.py,sha256=kVLfGd9Qwql4-6u86uwHbJoFCgYpG07r0cAR2Ngsq38,116
 physics/models/lvs/basic_lvs.py,sha256=xNXeN6RGSZkJLhtcW0n2xZU6YIOT4bKUIbOFdmh4zc0,621
@@ -45,10 +46,10 @@ physics/models/motor/basic_motor.py,sha256=hHGngG5lvZNzw7qgU3-c_3KFMKQ9siZCm471R
 physics/models/motor/motor.rs,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 physics/models/regen/__init__.py,sha256=JzyRYKwT89FQ6_p9ofCqusl2fnWGHulyiK4P4f8Lakc,126
 physics/models/regen/base_regen.py,sha256=lY44jrTSHEo8Xv7hKCjo4C3Jx0PUgilyITHwQchT2bM,101
-physics/models/regen/basic_regen.py,sha256=RY730lQLJ_gKkm2wJ68t1OPTmcz9xxGmu0yBLwHCGoQ,1811
+physics/models/regen/basic_regen.py,sha256=SZl7nj75w-3uczfNfaZAMtcC4WO8M2mTmwbnB0HmrtU,2402
 physics/models/regen/regen.rs,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ubc_solar_physics-1.2.0.dist-info/LICENSE,sha256=1Vq7OikLHh7N0xsmTPHCmPkOxk1AXrMK9k1a1icQFlk,1087
-ubc_solar_physics-1.2.0.dist-info/METADATA,sha256=nPuG2LtB0tkAdyZqiH_xYFiVCR4DmG0aFDQwPj-zBEU,5107
-ubc_solar_physics-1.2.0.dist-info/WHEEL,sha256=yNnHoQL2GZYIUXm9YvoaBpFjGlUoK9qq9oqYeudrWlE,101
-ubc_solar_physics-1.2.0.dist-info/top_level.txt,sha256=aws060Zz-1h0Kx76JzcE1gLA_AfS1lrRtTCsyUYwDvM,8
-ubc_solar_physics-1.2.0.dist-info/RECORD,,
+ubc_solar_physics-1.4.0.dist-info/LICENSE,sha256=1Vq7OikLHh7N0xsmTPHCmPkOxk1AXrMK9k1a1icQFlk,1087
+ubc_solar_physics-1.4.0.dist-info/METADATA,sha256=d_AzqplNDIwtWaZWavMufkFT6QdwjlxwvFCPherV6MA,5107
+ubc_solar_physics-1.4.0.dist-info/WHEEL,sha256=lPxm9M09dVYWZ0wAh0Zu0ADFguuSXLRXmaW8X9Lg2rA,101
+ubc_solar_physics-1.4.0.dist-info/top_level.txt,sha256=aws060Zz-1h0Kx76JzcE1gLA_AfS1lrRtTCsyUYwDvM,8
+ubc_solar_physics-1.4.0.dist-info/RECORD,,

{ubc_solar_physics-1.2.0.dist-info → ubc_solar_physics-1.4.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (75.8.2)
 Root-Is-Purelib: false
 Tag: cp311-cp311-win_amd64