ubc-solar-physics 1.1.0__cp310-cp310-macosx_11_0_arm64.whl → 1.7.4__cp310-cp310-macosx_11_0_arm64.whl

physics/models/motor/basic_motor.py

@@ -1,6 +1,6 @@
 import math
 import numpy as np
-
+from numpy.typing import NDArray
 from physics.models.motor.base_motor import BaseMotor
 from physics.models.constants import ACCELERATION_G, AIR_DENSITY
 
@@ -33,7 +33,7 @@ class BasicMotor(BaseMotor):
         # print("torque experienced by motor: {} Nm".format(self.constant_torque))
 
     @staticmethod
-    def calculate_motor_efficiency(motor_angular_speed, motor_output_energy, tick):
+    def calculate_motor_efficiency(motor_angular_speed, motor_output_energy, tick, *args, **kwargs):
         """
 
         Calculates a NumPy array of motor efficiency from NumPy array of operating angular speeds and NumPy array
@@ -98,19 +98,20 @@ class BasicMotor(BaseMotor):
 
         return e_mc
 
-    def calculate_energy_in(self, required_speed_kmh, gradients, wind_speeds, tick):
+    def calculate_net_force(self,
+                            required_speed_kmh: NDArray,
+                            wind_speeds: NDArray,
+                            gradients: NDArray
+                            ) -> tuple[NDArray, NDArray]:
         """
-
-        Create a function which takes in array of elevation, array of wind speed, required
-            speed, returns the consumed energy.
-
-        :param np.ndarray required_speed_kmh: (float[N]) required speed array in km/h
-        :param np.ndarray gradients: (float[N]) gradient at parts of the road
-        :param np.ndarray wind_speeds: (float[N]) speeds of wind in m/s, where > 0 means against the direction of the vehicle
-        :param float tick: length of 1 update cycle in seconds
-        :returns: (float[N]) energy expended by the motor at every tick
-        :rtype: np.ndarray
-
+        Calculate the net force on the car, and the required wheel angular velocity.
+        Currently, considers:
+            1. Rolling resistance of the wheels on the road
+            2. Drag force (wind + forward velocity)
+            3. Acceleration force (a = F / m)
+            4. Gravitational force (force to go uphill)
+
+        :return: net force in N, wheel angular velocity in rad/s
         """
         required_speed_ms = required_speed_kmh / 3.6
 
@@ -129,6 +130,24 @@ class BasicMotor(BaseMotor):
 
         net_force = road_friction_array + drag_forces + g_forces + acceleration_force
 
+        return net_force, required_angular_speed_rads
+
+    def calculate_energy_in(self, required_speed_kmh, gradients, wind_speeds, tick, **kwargs):
+        """
+
+        Create a function which takes in array of elevation, array of wind speed, required
+            speed, returns the consumed energy.
+
+        :param np.ndarray required_speed_kmh: (float[N]) required speed array in km/h
+        :param np.ndarray gradients: (float[N]) gradient at parts of the road
+        :param np.ndarray wind_speeds: (float[N]) speeds of wind in m/s, where > 0 means against the direction of the vehicle
+        :param float tick: length of 1 update cycle in seconds
+        :returns: (float[N]) energy expended by the motor at every tick
+        :rtype: np.ndarray
+
+        """
+        net_force, required_angular_speed_rads = self.calculate_net_force(required_speed_kmh, wind_speeds, gradients)
+
         motor_output_energies = required_angular_speed_rads * net_force * self.tire_radius * tick
         motor_output_energies = np.clip(motor_output_energies, a_min=0, a_max=None)
 

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)

physics/models.rs

@@ -1,5 +1,5 @@
 mod arrays;
-mod battery;
+pub mod battery;
 mod lvs;
 mod motor;
 mod regen;

physics_rs/__init__.pyi

@@ -0,0 +1,111 @@
+import numpy as np
+
+
+def constrain_speeds(speed_limits: np.ndarray, speeds: np.ndarray, tick: int) -> np.ndarray:
+    """
+    Constrains the vehicle speeds based on the speed limits and computes new speeds.
+
+    :param speed_limits: Array of speed limits (km/h) for each point.
+    :param speeds: Array of vehicle speeds (km/h).
+    :param tick: The time step (in some unit, e.g., seconds or ticks).
+
+    :return: A NumPy array of constrained vehicle speeds (km/h).
+    """
+    ...
+
+
+def calculate_array_ghi_times(python_local_times: np.ndarray) -> tuple[np.ndarray, np.ndarray]:
+    """
+    Calculates the array of GHI times based on local times.
+
+    :param python_local_times: Array of local times (UNIX timestamps or other format).
+
+    :return: A tuple of two NumPy arrays:
+        - Day of year (f64)
+        - Local time (f64)
+    """
+    ...
+
+
+def closest_gis_indices_loop(python_cumulative_distances: np.ndarray,
+                             python_average_distances: np.ndarray) -> np.ndarray:
+    """
+    Finds the closest GIS indices based on cumulative and average distances.
+
+    :param python_cumulative_distances: Array of cumulative distances.
+    :param python_average_distances: Array of average distances.
+
+    :return: A NumPy array of indices (i64) corresponding to the closest GIS indices.
+    """
+    ...
+
+
+def closest_weather_indices_loop(
+        python_cumulative_distances: np.ndarray,
+        python_average_distances: np.ndarray
+) -> np.ndarray:
+    """
+    Finds the closest weather indices based on cumulative and average distances.
+
+    :param python_cumulative_distances: Array of cumulative distances.
+    :param python_average_distances: Array of average distances.
+
+    :return: A NumPy array of indices (i64) corresponding to the closest weather indices.
+    """
+    ...
+
+
+def weather_in_time(
+        python_unix_timestamps: np.ndarray,
+        python_indices: np.ndarray,
+        python_weather_forecast: np.ndarray,
+        index: int
+) -> np.ndarray:
+    """
+    Retrieves the weather forecast at specific times for given indices.
+
+    :param python_unix_timestamps: Array of UNIX timestamps.
+    :param python_indices: Array of indices to look up.
+    :param python_weather_forecast: Array of weather forecasts.
+    :param index: A specific index to look up in the weather forecast.
+
+    :return: A NumPy array of weather values (f64) at the specified times and indices.
+    """
+    ...
+
+
+def update_battery_state(
+        python_energy_or_current_array: np.ndarray,
+        time_step: float,
+        initial_state_of_charge: float,
+        initial_polarization_potential: float,
+        python_internal_resistance_lookup: np.ndarray,
+        python_open_circuit_voltage_lookup: np.ndarray,
+        python_polarization_resistance_lookup: np.ndarray,
+        python_polarization_capacitance_lookup: np.ndarray,
+        nominal_charge_capacity: float,
+        is_power: bool,
+        quantization_step: float,
+        min_soc: float
+) -> tuple[np.ndarray, np.ndarray]:
+    """
+    Updates the battery state (SOC and terminal voltage) based on energy/current input.
+
+    :param python_energy_or_current_array: Array of energy or current input values (f64).
+    :param time_step: Time step (f64).
+    :param initial_state_of_charge: Initial state of charge (f64).
+    :param initial_polarization_potential: Initial polarization potential (f64).
+    :param python_internal_resistance_lookup: Array of internal resistance values (f64).
+    :param python_open_circuit_voltage_lookup: Array of open-circuit voltage values (f64).
+    :param python_polarization_resistance_lookup: Array of polarization resistance values (f64).
+    :param python_polarization_capacitance_lookup: Array of polarization capacitance values (f64).
+    :param nominal_charge_capacity: Nominal charge capacity (f64).
+    :param is_power: Boolean flag to indicate if the input is power (`True`) or current (`False`).
+    :param quantization_step: The step size used to quantize the SOC (f64).
+    :param min_soc: The minimum SOC used when computing the lookup tables
+
+    :return: A tuple containing:
+        - An array of updated SOC values (f64).
+        - An array of updated terminal voltage values (f64).
+    """
+    ...

{ubc_solar_physics-1.1.0.dist-info → ubc_solar_physics-1.7.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ubc-solar-physics
-Version: 1.1.0
+Version: 1.7.4
 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
@@ -50,13 +50,13 @@ Requires-Dist: jaraco.classes ==3.4.0
 Requires-Dist: jaraco.context ==5.3.0
 Requires-Dist: jaraco.functools ==4.0.2
 Requires-Dist: keyring ==25.3.0
-Requires-Dist: llvmlite ==0.43.0
+Requires-Dist: llvmlite
 Requires-Dist: markdown-it-py ==3.0.0
 Requires-Dist: mdurl ==0.1.2
 Requires-Dist: more-itertools ==10.4.0
 Requires-Dist: nh3 ==0.2.18
-Requires-Dist: numba ==0.60.0
-Requires-Dist: numpy ==2.0.1
+Requires-Dist: numba
+Requires-Dist: numpy >=2
 Requires-Dist: pkginfo ==1.10.0
 Requires-Dist: Pygments ==2.18.0
 Requires-Dist: readme-renderer ==44.0
@@ -67,6 +67,13 @@ Requires-Dist: rich ==13.7.1
 Requires-Dist: tqdm ==4.66.5
 Requires-Dist: urllib3 ==2.2.2
 Requires-Dist: zipp ==3.20.0
+Requires-Dist: filterpy ==1.4.5
+Requires-Dist: toml ==0.10.2
+Requires-Dist: pandas
+Requires-Dist: pydantic ==2.9.2
+Requires-Dist: scipy
+Requires-Dist: tomli
+Requires-Dist: scipy-stubs
 
 # UBC Solar Physics
 

{ubc_solar_physics-1.1.0.dist-info → ubc_solar_physics-1.7.4.dist-info}/RECORD

@@ -1,15 +1,16 @@
-core.cpython-310-darwin.so,sha256=4Ncljck8ZsBPpOhu8INlfppftIfBYCBOgu_wyEMz_LM,647840
-ubc_solar_physics-1.1.0.dist-info/RECORD,,
-ubc_solar_physics-1.1.0.dist-info/LICENSE,sha256=DAej6EJNqQWTair3XPAQiqoJbly4BAT1JMOsZxoZvH0,1066
-ubc_solar_physics-1.1.0.dist-info/WHEEL,sha256=1MPyPs9-MLQHZykOzeBqIZBROBGKPY6rzfLYqQeUsL8,109
-ubc_solar_physics-1.1.0.dist-info/top_level.txt,sha256=aws060Zz-1h0Kx76JzcE1gLA_AfS1lrRtTCsyUYwDvM,8
-ubc_solar_physics-1.1.0.dist-info/METADATA,sha256=fs8TduPhyFuJ9kT5Q6eGpCrQVh33xuMs6L_jZpR42Uw,4840
-physics/_version.py,sha256=CqDGE4B1ZqZ-56mxeOFcXRTmlxrdOh4ayrjbcPjziE4,411
-physics/lib.rs,sha256=u5R4JE2-HNfVrjNRjuBQw4ervJiV3VDHygcxsL06Ou4,4149
-physics/models.rs,sha256=KfvtkWTmbsqr7Y6hN0jPe7hTTgCN6Osydkb4fLnZHwA,55
+physics_rs.cpython-310-darwin.so,sha256=xkBEPe7s7WjeQQHDfJ2QBYxEmXV4h_A3XVFSttVBpog,699728
+physics_rs/__init__.pyi,sha256=bMMIbLFgpSYq37i9xHpvdoVlMuI7IRZ9bdbLCcIBeO8,4235
+ubc_solar_physics-1.7.4.dist-info/RECORD,,
+ubc_solar_physics-1.7.4.dist-info/LICENSE,sha256=DAej6EJNqQWTair3XPAQiqoJbly4BAT1JMOsZxoZvH0,1066
+ubc_solar_physics-1.7.4.dist-info/WHEEL,sha256=Sr6WlJF6U27nFVGVWvIEC4coXGfodvHZVfYGHD45Ez0,109
+ubc_solar_physics-1.7.4.dist-info/top_level.txt,sha256=jBZ5oyp1QQOrKodHG2UH9PMPEiZtza_q3y6fp3lEmQs,19
+ubc_solar_physics-1.7.4.dist-info/METADATA,sha256=3959K0MWeKLHSPDZtICr_OxxkURBB5gytYEI7CXref0,5002
+physics/_version.py,sha256=RXCVfb--6hzsLq9eHm4YOs9d-j0v74-HRGs2DFWnpjQ,411
+physics/lib.rs,sha256=BGgj8jwbWQ7mkBDfKyTqH5jZGKAAb9U0sSByUaI-Los,7169
+physics/models.rs,sha256=N5342VhLaLSlPLHZ7s1VDIEPY76-rQN03lY_wd2HS1A,59
 physics/__init__.py,sha256=7939mrehCy0ogupHq26hUk1MkAjh2xmbD30GscdC_D8,169
 physics/environment.rs,sha256=VWX1haUCO-WenD0dawS5FxY9dquiUT6Uud3p3dAnJZA,34
-physics/models/battery.rs,sha256=GzPA7uaF5FdewEFZL2eOt9ZeA1GzfRDQ9db_qkEpLR8,12
+physics/models/battery.rs,sha256=fTL9O20fQarT_CFsmMSqVEZNe_sTejWMaAR8Fc-z_ak,16
 physics/models/lvs.rs,sha256=uyJ1ZZ1Phq8cWCzr2aevCWzt8MlhCw9DO5ObUvEs8ds,8
 physics/models/constants.py,sha256=mw0IkjhSJe51inbbzvVpHnpGLY_AoWxIxjfjcUF4cd8,816
 physics/models/motor.rs,sha256=Iya1C_YF09KMy-9N-Mt-rBf1EIAs2Bf3Q4eDvyFuAoc,10
@@ -20,19 +21,24 @@ physics/models/lvs/basic_lvs.py,sha256=UH6VmVWrSo-tKvcbSOm3Ptp0edz1xDQiQsM4HlOJ_
 physics/models/lvs/lvs.rs,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 physics/models/lvs/__init__.py,sha256=GkO6SJxbbSnXYLdMDvsvTRhXotV3zaRNmYBgziQLGB8,107
 physics/models/lvs/base_lvs.py,sha256=PVwPgCaJ_TcV2mQf3X2pngi0aG-jTLTeloL-LQV3jMU,110
+physics/models/motor/advanced_motor.py,sha256=EL86tCDSQCTT55EdXnmtPaIL9YS2o5p2u3QiLuoZuCA,8758
 physics/models/motor/motor.rs,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-physics/models/motor/__init__.py,sha256=tDFCMk8rdv2c_0Qp0EAtTpw0uKBnza-9BlMaNthcw0c,119
-physics/models/motor/basic_motor.py,sha256=R_uicd1iPr_dZWhAxE1ZXPfwk5JNaVaFb2_3Slhxvwk,7728
-physics/models/motor/base_motor.py,sha256=1Gst4p8H491AATMJ054Ia8lsoUGLRj2iM_2otCom-Jw,95
+physics/models/motor/__init__.py,sha256=zkV7LiAozFNu9CRWWXeCbCDepjsaUIYT8Q2dkXJgLsM,183
+physics/models/motor/basic_motor.py,sha256=-_rKIFCRRLniC1yHr_8fRsmj6xvHuAzPqA168vTDkds,8626
+physics/models/motor/base_motor.py,sha256=34wy8x945HvJijn9267fdAR_JNHxH_7bYxYbVl71WBA,97
 physics/models/arrays/basic_array.py,sha256=cGBwyrYpR313ECJ-SwnrK3JzYo24NRE70j8sj-sxFQI,1332
 physics/models/arrays/base_array.py,sha256=ZUjehd7vwNOBdFLUk9WJUeGOi9DPopYplH1gqAMnKgA,95
 physics/models/arrays/arrays.rs,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 physics/models/arrays/__init__.py,sha256=yavs1K3JA6x3Aa-U1JCZJlcWggCOFrVxrrMCGsiceAw,119
-physics/models/battery/battery.rs,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-physics/models/battery/basic_battery.py,sha256=xkY77UpWz9qTuqT2t_tm5CZbtScQE6r3vkzlMXlnXog,5755
-physics/models/battery/__init__.py,sha256=BIaUG06jULcloNv0hDFKjyGmdzWp02ZiV6MI_OZ8wb4,131
+physics/models/battery/battery_config.toml,sha256=Fn1pb3NJJ_nclxm9nfGEQKmJYA2d5a9jCAUbwUGu6Uw,1092
+physics/models/battery/battery.rs,sha256=10NAAGg99gQ70Kjd4kVuVHBxp3J6AgXfxEYKZUzu5DQ,5275
+physics/models/battery/basic_battery.py,sha256=u0aO_iWKicVRECbDzLIs8goaWD5tLMnYGNe948lKC7U,5754
+physics/models/battery/__init__.py,sha256=bIESRM8eEpaKSYMoliXD7rs3TUkAawTN9i3-YB2WCZg,630
+physics/models/battery/battery_config.py,sha256=V4CfzUTcOFcizpDU9-Ujn2zXbUnAqrhyARN9QXGH6fk,4052
+physics/models/battery/kalman_filter.py,sha256=kcX3SU1mNiY4-2YCUWAvqyTX6Cww7Pq7zaxaqh8ltgM,8725
 physics/models/battery/base_battery.py,sha256=yK-bkA2OolE6nIDn5rf5nzi8gwm-AqQRmgsQioi_UOA,1203
-physics/models/regen/basic_regen.py,sha256=eAQAb-bWA-CINGFK2Xykh7rIm4c16DwyZzHjdOzANrg,1772
+physics/models/battery/battery_model.py,sha256=kODVlBZAIpPD_EB0UPlOeQv5HP-tMu6S-C6mEOJMHv4,10264
+physics/models/regen/basic_regen.py,sha256=kcp6Wkw2o72xO_0-UCNABWSC_QIkexcS72iblNVQFBA,2350
 physics/models/regen/base_regen.py,sha256=nWtmsm47wp9mx261OmSILwja32yYhzCLSNXWnzt82TY,95
 physics/models/regen/__init__.py,sha256=51t_BHuQqIVPPy_0b14MO6QGZayOO326JR7wK1egy-g,119
 physics/models/regen/regen.rs,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -42,10 +48,10 @@ physics/environment/environment.rs,sha256=yvzrjKHZ5vRvVip6lM34i8E0Ell_5fC3zyJDsb
 physics/environment/meteorology.rs,sha256=naWb7qYrtMkCE_tLAkM474fmxaufhCkyhy3TTUQ4Yw4,20
 physics/environment/meteorology/__init__.py,sha256=569as2j7kpv8Nh75M9xk9e7rTqsDPGo3Ii3nskD6F34,154
 physics/environment/meteorology/base_meteorology.py,sha256=d5TDNLUIBmTkLtJhv9qUq9KcfNKxzoM7xIOsfyNbwfI,2418
-physics/environment/meteorology/irradiant_meteorology.py,sha256=xV5gHzxLKZ9AXF3BGddBx0OjXuebvfkqNUyxSYOMjEo,5539
-physics/environment/meteorology/clouded_meteorology.py,sha256=Pm1O9bv80V37vlgEa48jkjvjvhiCkY56oIMMrBSiZgo,27641
+physics/environment/meteorology/irradiant_meteorology.py,sha256=1kqX4nEOUw-CYrLTusG6BdoZbZt_GEpfKMyey8YzLr0,5615
+physics/environment/meteorology/clouded_meteorology.py,sha256=aEqlozaMOyhhxGK7CCD6BVHAn_HZDpSAUwGUngikkp4,27665
 physics/environment/meteorology/meteorology.rs,sha256=Q3toiZv8M1updhoAnFDZ87YPy1afC9chUkF2IP9uA-I,5004
-physics/environment/gis/base_gis.py,sha256=PBaCz2irEArQs3k8HVG7BmAfC1HzA8FLPuYSiMxDmJo,632
+physics/environment/gis/base_gis.py,sha256=eVr4G7wAGlx6VsrCt2OuI8WzUMM50h2sHHvw8BOBur8,1046
 physics/environment/gis/__init__.py,sha256=Kp85UC1WvcAMBxbgvwaMTEk8ELYzwUJLCtP0e1hnMvM,90
-physics/environment/gis/gis.rs,sha256=ZCd7MbrENFXFl7MaLMGUl_kbqWKLc695Bf-MeWgo1S0,852
-physics/environment/gis/gis.py,sha256=fzP7Pl7gaZG7JEA4-CQXkR2gEfmSzejQMVwwo3l8Ni0,11400
+physics/environment/gis/gis.rs,sha256=_vXYMr7vNCC8Ip3CpQdyl6FA_3tCvOZeJd0-J5t4Eps,4865
+physics/environment/gis/gis.py,sha256=EAFDudUmLWCBtM5A_LO3-MV-98tj-Q3s7S2WaoJjUGg,13209

{ubc_solar_physics-1.1.0.dist-info → ubc_solar_physics-1.7.4.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.1.0)
+Generator: setuptools (74.1.3)
 Root-Is-Purelib: false
 Tag: cp310-cp310-macosx_11_0_arm64
 

ubc_solar_physics-1.7.4.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+physics
+physics_rs

ubc_solar_physics-1.1.0.dist-info/top_level.txt

@@ -1 +0,0 @@
-physics