MNT: minor adjustments before merging sensors

rocketpy/environment/tools.py

@@ -532,7 +532,7 @@ def utm_to_geodesic(  # pylint: disable=too-many-locals,too-many-statements
     x, y, utm_zone, hemis, semi_major_axis=6378137.0, flattening=1 / 298.257223563
 ):
     # NOTE: already documented in the Environment class.
-    # TODO: deprecated the static method from the environment class, use only this one.
+    # TODO: deprecate the static method from the environment class, use only this one.
 
     if hemis == "N":
         y = y + 10000000

rocketpy/motors/tank.py

@@ -1158,7 +1158,7 @@ def gas_volume(self):
         Function
             Volume of the gas as a function of time.
         """
-        # TODO: there's a bug on the gas_center_of_mass is I don't discretize here
+        # TODO: there's a bug on the gas_center_of_mass if I don't discretize here
         func = Function(self.geometry.total_volume).set_discrete_based_on_model(
             self.liquid_volume
         )

rocketpy/rocket/parachute.py

@@ -34,8 +34,8 @@ class Parachute:
            ``sensor.measurement`` attribute. The sensors are listed in the same
            order as they are added to the rocket.
 
-        The function should return True if the parachute ejection system should
-        be triggered and False otherwise.
+        The function should return ``True`` if the parachute ejection system
+        should be triggered and False otherwise.
 
         - A float value, representing an absolute height in meters. In this
         case, the parachute will be ejected when the rocket reaches this height

rocketpy/rocket/rocket.py

@@ -1347,30 +1347,29 @@ def add_parachute(
         self.parachutes.append(parachute)
         return self.parachutes[-1]
 
-    def add_sensor(self, sensor, position, x_offset=0, y_offset=0):
+    def add_sensor(self, sensor, position):
         """Adds a sensor to the rocket.
 
         Parameters
         ----------
         sensor : Sensor
             Sensor to be added to the rocket.
-        position : int, float, tuple
-            Position, in meters, of the sensor's coordinate system origin
-            relative to the user defined rocket coordinate system.
-        x_offset : int, float, optional
-            Distance in meters by which the sensor is to be translated in the
-            rocket's x direction relative to geometrical center line.
-            Default is 0.
-        y_offset : int, float, optional
-            Distance in meters by which the sensor is to be translated in the
-            rocket's y direction relative to geometrical center line.
-            Default is 0.
+        position : int, float, tuple, list, Vector
+            Position of the sensor. If a Vector, tuple or list is passed, it
+            must be in the format (x, y, z) where x, y, and z are defined in the
+            rocket's user defined coordinate system. If a single value is
+            passed, it is assumed to be along the z-axis (centerline) of the
+            rocket's user defined coordinate system and angular_position and
+            radius must be given.
 
         Returns
         -------
         None
         """
-        self.sensors.add(sensor, Vector([x_offset, y_offset, position]))
+        if isinstance(position, (float, int)):
+            position = (0, 0, position)
+        position = Vector(position)
+        self.sensors.add(sensor, position)
         try:
             sensor._attached_rockets[self] += 1
         except KeyError:

rocketpy/sensors/barometer.py

@@ -71,7 +71,7 @@ def __init__(
         sampling_rate : float
             Sample rate of the sensor in Hz.
         measurement_range : float, tuple, optional
-            The measurement range of the sensor in the Pa. If a float, the same
+            The measurement range of the sensor in Pa. If a float, the same
             range is applied both for positive and negative values. If a tuple,
             the first value is the positive range and the second value is the
             negative range. Default is np.inf.

rocketpy/sensors/gyroscope.py

@@ -228,8 +228,7 @@ def measure(self, time, **kwargs):
         )
         W = inertial_to_sensor @ omega
 
-        # Apply noise + bias
-        # Apply noise + bias and quatize
+        # Apply noise + bias and quantize
         W = self.apply_noise(W)
         W = self.apply_temperature_drift(W)
 

rocketpy/sensors/sensor.py

@@ -352,8 +352,6 @@ def __init__(
               standard rotation sequence is z-y-x (3-2-1) is used, meaning the
               sensor is first rotated by ψ around the x axis, then by θ around
               the new y axis and finally by φ around the new z axis.
-              TODO: x and y are not defined in the rocket class. User has no
-              way to know which axis is which.
             - A list of lists (matrix) of shape 3x3, representing the rotation
               matrix from the sensor frame to the rocket frame. The sensor frame
               of reference is defined as to have z axis along the sensor's normal

rocketpy/simulation/flight.py

@@ -706,7 +706,7 @@ def __simulate(self, verbose):
                     callback(self)
 
                 if self.sensors:
-                    # udot for all sensors
+                    # u_dot for all sensors
                     u_dot = phase.derivative(self.t, self.y_sol)
                     for sensor, position in node._component_sensors:
                         relative_position = position - self.rocket._csys * Vector(
@@ -3229,7 +3229,7 @@ def export_sensor_data(self, file_name, sensor=None):
 
         with open(file_name, "w") as file:
             json.dump(data_dict, file)
-        print("Sensor data exported to", file_name)
+        print("Sensor data exported to: ", file_name)
 
     def export_kml(  # TODO: should be moved out of this class.
         self,