ubc-solar-physics 1.7.11__cp311-cp311-macosx_11_0_arm64.whl → 1.8.1__cp311-cp311-macosx_11_0_arm64.whl

physics/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.7.11'
-__version_tuple__ = version_tuple = (1, 7, 11)
+__version__ = version = '1.8.1'
+__version_tuple__ = version_tuple = (1, 8, 1)

physics/environment/gis/base_gis.py

@@ -24,6 +24,11 @@ class BaseGIS(ABC):
     def get_path(self) -> np.ndarray:
         raise NotImplementedError
 
+    @staticmethod
+    @abstractmethod
+    def calculate_speeds_and_position(speeds_kmh: NDArray, track_speeds, path_distances, dt):
+        raise NotImplementedError
+
     @abstractmethod
     def calculate_current_heading_array(self) -> np.ndarray:
         raise NotImplementedError

physics/environment/gis/gis.py

@@ -34,21 +34,9 @@ class GIS(BaseGIS):
         self.path_time_zones = route_data['time_zones']
         self.num_unique_coords = route_data['num_unique_coords']
 
-        if current_coord is not None:
-            if not np.array_equal(current_coord, origin_coord):
-                logging.warning("Current position is not origin position. Modifying path data.\n")
-
-                # We need to find the closest coordinate along the path to the vehicle position
-                current_coord_index = GIS._find_closest_coordinate_index(current_coord, self.path)
-
-                # All coords before the current coordinate should be discarded
-                self.path = self.path[current_coord_index:]
-                self.path_elevations = self.path_elevations[current_coord_index:]
-                self.path_time_zones = self.path_time_zones[current_coord_index:]
-
-        self.path_distances = calculate_path_distances(self.path)
+        self.path_distances = calculate_path_distances(self.path)[:self.num_unique_coords]
         self.path_length = np.cumsum(calculate_path_distances(self.path[:self.num_unique_coords]))[-1]
-        self.path_gradients = calculate_path_gradients(self.path_elevations, self.path_distances)
+        self.path_gradients = calculate_path_gradients(self.path_elevations[:self.num_unique_coords], self.path_distances)
 
     @staticmethod
     def process_KML_file(route_file):
@@ -83,6 +71,51 @@ class GIS(BaseGIS):
         """
         return physics_rs.closest_gis_indices_loop(distances, self.path_distances)
 
+    def calculate_speeds_and_position(self, speeds_kmh: NDArray, track_speeds: NDArray, dt: int):
+        try:
+            return physics_rs.calculate_speeds_and_position(speeds_kmh, self.path_distances, track_speeds, dt)
+
+        except Exception:
+            return self._py_calculate_speeds_and_position(speeds_kmh, track_speeds, dt)
+
+    def _py_calculate_speeds_and_position(self, speeds_kmh: NDArray, track_speeds: NDArray, dt: int):
+        """
+        Given the original, lap-averaged `speeds_kmh` and an array of speed deviations in km/h for each track index,
+        compute the position and actual speed as simulation-time arrays.
+
+        :param speeds_kmh: Lap-averaged speeds in km/h.
+        :param track_speeds: A speed deviation in km/h for each track index. Expects the mean to be at 0.
+        :param dt:
+        :return:
+        """
+        result = []
+        actual_speeds_kmh = []
+
+        with tqdm(total=len(speeds_kmh), file=sys.stdout, desc="Calculating closest GIS indices") as pbar:
+            distance_travelled = 0
+            track_index = 0
+
+            for lap_speed in speeds_kmh:
+                if lap_speed > 0:
+                    actual_speed = lap_speed + track_speeds[track_index]
+                else:
+                    actual_speed = 0
+
+                actual_speeds_kmh.append(actual_speed)
+                distance_travelled += actual_speed * dt
+
+                while distance_travelled > self.path_distances[track_index]:
+                    distance_travelled -= self.path_distances[track_index]
+                    track_index += 1
+
+                    if track_index >= len(self.path_distances):
+                        track_index = 0
+
+                result.append(track_index)
+                pbar.update(1)
+
+        return np.array(result), np.array(actual_speeds_kmh)
+
     def calculate_driving_speeds(
             self,
             average_lap_speeds: ArrayLike,

physics/environment/gis/gis.rs

@@ -26,6 +26,44 @@ pub fn rust_closest_gis_indices_loop(
     result
 }
 
+pub fn calculate_speeds_and_position(
+    speeds_kmh: ArrayView1<'_, f64>,
+    path_distances: ArrayView1<'_, f64>,
+    track_speeds: ArrayView1<'_, f64>,
+    simulation_dt: u32,
+) -> (Vec<usize>, Vec<f64>) {
+    let mut track_index: usize = 0;
+    let mut distance_travelled: f64 = 0.0;
+    let n = path_distances.len();
+
+    let mut result: Vec<usize> = Vec::with_capacity(speeds_kmh.len());
+    let mut actual_speeds_kmh: Vec<f64> = Vec::with_capacity(speeds_kmh.len());
+
+    for &speed in speeds_kmh {
+        let actual_speed = if speed > 0.0 {
+            speed + track_speeds[track_index]
+        } else {
+            0.0
+        };
+
+        actual_speeds_kmh.push(actual_speed);
+        distance_travelled += actual_speed * simulation_dt as f64;
+
+        while distance_travelled > path_distances[track_index] {
+            distance_travelled -= path_distances[track_index];
+            track_index += 1;
+
+            if track_index >= n {
+                track_index = 0;
+            }
+        }
+
+        result.push(track_index);
+    }
+
+    (result, actual_speeds_kmh)
+}
+
 ///
 /// Generate valid driving speeds as a simulation-time array given a set of average speeds for each
 /// simulated lap.

physics/lib.rs

@@ -5,7 +5,7 @@ use pyo3::types::PyModule;
 
 pub mod environment;
 pub mod models;
-use crate::environment::gis::gis::{rust_closest_gis_indices_loop, get_driving_speeds};
+use crate::environment::gis::gis::{rust_closest_gis_indices_loop, get_driving_speeds, calculate_speeds_and_position};
 use crate::environment::meteorology::meteorology::{rust_calculate_array_ghi_times, rust_closest_weather_indices_loop, rust_weather_in_time};
 use crate::models::battery::battery::update_battery_state;
 
@@ -135,6 +135,29 @@ fn rust_simulation(_py: Python, m: &PyModule) -> PyResult<()> {
         (py_soc_array, py_voltage_array)
     }
 
+    #[pyfn(m)]
+    #[pyo3(name = "calculate_speeds_and_position")]
+    fn calculate_speeds_and_position_py<'py>(
+        py: Python<'py>,
+        speeds_kmh_py: PyReadwriteArray1<'py, f64>,
+        path_distances_py: PyReadwriteArray1<'py, f64>,
+        track_speeds_py: PyReadwriteArray1<'py, f64>,
+        simulation_dt: u32,
+    ) -> (&'py PyArray1<usize>, &'py PyArray1<f64>) {
+        let speeds_kmh = speeds_kmh_py.as_array();
+        let path_distances = path_distances_py.as_array();
+        let track_speeds = track_speeds_py.as_array();
+        let (gis_indices, actual_speeds_kmh): (Vec<usize>, Vec<f64>) = calculate_speeds_and_position(
+            speeds_kmh,
+            path_distances,
+            track_speeds,
+            simulation_dt,
+        );
+        let gis_indices_py = PyArray::from_vec(py, gis_indices);
+        let actual_speeds_kmh_py = PyArray::from_vec(py, actual_speeds_kmh);
+        (gis_indices_py, actual_speeds_kmh_py)
+    }
+
     #[pyfn(m)]
     #[pyo3(name = "get_driving_speeds")]
     fn py_get_driving_speeds<'py>(

physics/models/motor/base_motor.py

@@ -2,7 +2,7 @@ from abc import ABC
 
 
 class BaseMotor(ABC):
-    def __init__(self):
+    def __init__(self, **kwargs):
         super().__init__()
 
 

physics/models/motor/basic_motor.py

@@ -6,7 +6,7 @@ from physics.models.constants import ACCELERATION_G, AIR_DENSITY
 
 
 class BasicMotor(BaseMotor):
-    def __init__(self, vehicle_mass, road_friction, tire_radius, vehicle_frontal_area, drag_coefficient):
+    def __init__(self, vehicle_mass, road_friction, tire_radius, vehicle_frontal_area, drag_coefficient, **kwargs):
         super().__init__()
 
         # Instantaneous voltage supplied by the battery to the motor controller

{ubc_solar_physics-1.7.11.dist-info → ubc_solar_physics-1.8.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ubc-solar-physics
-Version: 1.7.11
+Version: 1.8.1
 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>

{ubc_solar_physics-1.7.11.dist-info → ubc_solar_physics-1.8.1.dist-info}/RECORD

@@ -1,12 +1,12 @@
-physics_rs.cpython-311-darwin.so,sha256=XIbYwtCTpALBKvfvL0azWVYxz-2LXgJ8VdEjBzlVCNk,700032
-ubc_solar_physics-1.7.11.dist-info/RECORD,,
-ubc_solar_physics-1.7.11.dist-info/LICENSE,sha256=DAej6EJNqQWTair3XPAQiqoJbly4BAT1JMOsZxoZvH0,1066
-ubc_solar_physics-1.7.11.dist-info/WHEEL,sha256=4IOVzhA4BSemBUQpMJwow04g523NGMsZez_bd6vzIXs,109
-ubc_solar_physics-1.7.11.dist-info/top_level.txt,sha256=jBZ5oyp1QQOrKodHG2UH9PMPEiZtza_q3y6fp3lEmQs,19
-ubc_solar_physics-1.7.11.dist-info/METADATA,sha256=dvnlQ8xbJnPWDzpvhi3MU6UIDqI2CzQlm1BQMV0-uhI,5003
+physics_rs.cpython-311-darwin.so,sha256=CI4XXRGSTZQ_q3pL3wH10RnxpNUC2Lr7WEMwqTwfjBU,701728
+ubc_solar_physics-1.8.1.dist-info/RECORD,,
+ubc_solar_physics-1.8.1.dist-info/LICENSE,sha256=DAej6EJNqQWTair3XPAQiqoJbly4BAT1JMOsZxoZvH0,1066
+ubc_solar_physics-1.8.1.dist-info/WHEEL,sha256=4IOVzhA4BSemBUQpMJwow04g523NGMsZez_bd6vzIXs,109
+ubc_solar_physics-1.8.1.dist-info/top_level.txt,sha256=jBZ5oyp1QQOrKodHG2UH9PMPEiZtza_q3y6fp3lEmQs,19
+ubc_solar_physics-1.8.1.dist-info/METADATA,sha256=4LsfRJXbxi00HS2ll_dNHjTRNQhPaX19emja36CJa48,5002
 physics_rs/__init__.pyi,sha256=bMMIbLFgpSYq37i9xHpvdoVlMuI7IRZ9bdbLCcIBeO8,4235
-physics/_version.py,sha256=TBdoKbRERu0RLmgOlLn0qO1c9vmbdCN_H7OMlZVRf8o,413
-physics/lib.rs,sha256=BGgj8jwbWQ7mkBDfKyTqH5jZGKAAb9U0sSByUaI-Los,7169
+physics/_version.py,sha256=0CBOWvcgj3z82UQGmgPZNYucWtZfu-kClLlOblR1VJs,411
+physics/lib.rs,sha256=uMeIRNVeeIpaxvvNM7qvCoSUzTzOdwOBEff_fP9XH18,8161
 physics/models.rs,sha256=N5342VhLaLSlPLHZ7s1VDIEPY76-rQN03lY_wd2HS1A,59
 physics/__init__.py,sha256=7939mrehCy0ogupHq26hUk1MkAjh2xmbD30GscdC_D8,169
 physics/environment.rs,sha256=VWX1haUCO-WenD0dawS5FxY9dquiUT6Uud3p3dAnJZA,34
@@ -24,8 +24,8 @@ physics/models/lvs/base_lvs.py,sha256=PVwPgCaJ_TcV2mQf3X2pngi0aG-jTLTeloL-LQV3jM
 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=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/motor/basic_motor.py,sha256=RF0xwruBwu6Cvs1JtAM92ujvFjbmAYxwJfulUM9tlYo,8636
+physics/models/motor/base_motor.py,sha256=GTK0cQ5RiXdrrfhenvc2_zwF2XKnqupHI8gZdi-w3oM,107
 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
@@ -51,7 +51,7 @@ physics/environment/meteorology/base_meteorology.py,sha256=d5TDNLUIBmTkLtJhv9qUq
 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=hoykIc-ZicJBTklI2vaucsvocjqDab9dvxY4pwvlKcc,1079
+physics/environment/gis/base_gis.py,sha256=iycttQ_bL2WXXQyXn9LokH8dv0ekQvCOJ0ONch__mYM,1246
 physics/environment/gis/__init__.py,sha256=Kp85UC1WvcAMBxbgvwaMTEk8ELYzwUJLCtP0e1hnMvM,90
-physics/environment/gis/gis.rs,sha256=_vXYMr7vNCC8Ip3CpQdyl6FA_3tCvOZeJd0-J5t4Eps,4865
-physics/environment/gis/gis.py,sha256=Y-pznuK5f0HRTiiI29fm7YeHiGFjOuTivnNMp6AlKTQ,13355
+physics/environment/gis/gis.rs,sha256=YEJ_0PkwYZfCg1TxEKLAKrpy4UdZTJLItQZVQMIULTc,5947
+physics/environment/gis/gis.py,sha256=KTtztphHaiU3oHgeUXVUtSa2XLUqg4iaYaSAFFJVBTQ,14531