ENH: simplifying variable names

Author: ArthurJWH

rocketpy/rocket/parachute.py

@@ -92,10 +92,10 @@ class Parachute:
         Function of noisy_pressure_signal.
     Parachute.clean_pressure_signal_function : Function
         Function of clean_pressure_signal.
-    Parachute.parachute_radius : float
+    Parachute.radius : float
         Length of the non-unique semi-axis (radius) of the inflated hemispheroid
         parachute in meters.
-    Parachute.parachute_height : float, None
+    Parachute.height : float, None
         Length of the unique semi-axis (height) of the inflated hemispheroid
         parachute in meters.
     Parachute.porosity : float
@@ -111,8 +111,8 @@ def __init__(
         sampling_rate,
         lag=0,
         noise=(0, 0, 0),
-        parachute_radius=1.5,
-        parachute_height=None,
+        radius=1.5,
+        height=None,
         porosity=0.0432,
     ):
         """Initializes Parachute class.
@@ -166,11 +166,11 @@ def __init__(
             The values are used to add noise to the pressure signal which is
             passed to the trigger function. Default value is ``(0, 0, 0)``.
             Units are in Pa.
-        parachute_radius : float, optional
+        radius : float, optional
             Length of the non-unique semi-axis (radius) of the inflated hemispheroid
             parachute. Default value is 1.5.
             Units are in meters.
-        parachute_height : float, optional
+        height : float, optional
             Length of the unique semi-axis (height) of the inflated hemispheroid
             parachute. Default value is the radius of the parachute.
             Units are in meters.
@@ -193,8 +193,8 @@ def __init__(
         self.clean_pressure_signal_function = Function(0)
         self.noisy_pressure_signal_function = Function(0)
         self.noise_signal_function = Function(0)
-        self.parachute_radius = parachute_radius
-        self.parachute_height = parachute_height or parachute_radius
+        self.radius = radius
+        self.height = height or radius
         self.porosity = porosity
         self.ka = 1.068 * (
             1
@@ -296,8 +296,8 @@ def to_dict(self, include_outputs=False):
             "sampling_rate": self.sampling_rate,
             "lag": self.lag,
             "noise": self.noise,
-            "parachute_radius": self.parachute_radius,
-            "parachute_height": self.parachute_height,
+            "radius": self.radius,
+            "height": self.height,
             "porosity": self.porosity,
         }
 
@@ -325,8 +325,8 @@ def from_dict(cls, data):
             sampling_rate=data["sampling_rate"],
             lag=data["lag"],
             noise=data["noise"],
-            parachute_radius=data.get("parachute_radius", 1.5),
-            parachute_height=data.get("parachute_height", None),
+            radius=data.get("radius", 1.5),
+            height=data.get("height", None),
             porosity=data.get("porosity", 0.0432),
         )
 

rocketpy/rocket/rocket.py

@@ -1440,8 +1440,8 @@ def add_parachute(
         sampling_rate=100,
         lag=0,
         noise=(0, 0, 0),
-        parachute_radius=1.5,
-        parachute_height=None,
+        radius=1.5,
+        height=None,
         porosity=0.0432,
     ):
         """Creates a new parachute, storing its parameters such as
@@ -1501,11 +1501,11 @@ def add_parachute(
             The values are used to add noise to the pressure signal which is
             passed to the trigger function. Default value is (0, 0, 0). Units
             are in pascal.
-        parachute_radius : float, optional
+        radius : float, optional
             Length of the non-unique semi-axis (radius) of the inflated hemispheroid
             parachute. Default value is 1.5.
             Units are in meters.
-        parachute_height : float, optional
+        height : float, optional
             Length of the unique semi-axis (height) of the inflated hemispheroid
             parachute. Default value is the radius of the parachute.
             Units are in meters.
@@ -1528,8 +1528,8 @@ def add_parachute(
             sampling_rate,
             lag,
             noise,
-            parachute_radius,
-            parachute_height,
+            radius,
+            height,
             porosity,
         )
         self.parachutes.append(parachute)

rocketpy/simulation/flight.py

@@ -1027,13 +1027,13 @@ def __simulate(self, verbose):
                                                 self, "parachute_cd_s", parachute_cd_s
                                             ),
                                             lambda self,
-                                            parachute_radius=parachute.parachute_radius: setattr(
+                                            parachute_radius=parachute.radius: setattr(
                                                 self,
                                                 "parachute_radius",
                                                 parachute_radius,
                                             ),
                                             lambda self,
-                                            parachute_height=parachute.parachute_height: setattr(
+                                            parachute_height=parachute.height: setattr(
                                                 self,
                                                 "parachute_height",
                                                 parachute_height,

rocketpy/stochastic/stochastic_parachute.py

@@ -39,8 +39,8 @@ def __init__(
         sampling_rate=None,
         lag=None,
         noise=None,
-        parachute_radius=None,
-        parachute_height=None,
+        radius=None,
+        height=None,
         porosity=None,
     ):
         """Initializes the Stochastic Parachute class.
@@ -66,9 +66,9 @@ def __init__(
         noise : list
             List of tuples in the form of (mean, standard deviation,
             time-correlation).
-        parachute_radius : tuple, list, int, float
+        radius : tuple, list, int, float
             Radius of the parachute in meters.
-        parachute_height : tuple, list, int, float
+        height : tuple, list, int, float
             Height of the parachute in meters.
         porosity : tuple, list, int, float
             Porosity of the parachute.
@@ -79,8 +79,8 @@ def __init__(
         self.sampling_rate = sampling_rate
         self.lag = lag
         self.noise = noise
-        self.parachute_radius = parachute_radius
-        self.parachute_height = parachute_height
+        self.radius = radius
+        self.height = height
         self.porosity = porosity
 
         self._validate_trigger(trigger)
@@ -93,8 +93,8 @@ def __init__(
             lag=lag,
             noise=noise,
             name=None,
-            parachute_radius=parachute_radius,
-            parachute_height=parachute_height,
+            radius=radius,
+            height=height,
             porosity=porosity,
         )