Skip to content

Commit f84459d

Browse files
committed
DOC: improved descriptions of the new parameters
1 parent c5ce166 commit f84459d

File tree

2 files changed

+19
-15
lines changed

2 files changed

+19
-15
lines changed

rocketpy/rocket/parachute.py

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010

1111
class Parachute:
12-
"""Keeps parachute information.
12+
"""Keeps information of the parachute, which is modeled as a hemispheroid.
1313
1414
Attributes
1515
----------
@@ -93,12 +93,14 @@ class Parachute:
9393
Parachute.clean_pressure_signal_function : Function
9494
Function of clean_pressure_signal.
9595
Parachute.parachute_radius : float
96-
Radius of the inflated parachute in meters.
96+
Length of the non-unique semi-axis (radius) of the inflated hemispheroid
97+
parachute in meters.
9798
Parachute.parachute_height : float
98-
Height of the inflated parachute in meters.
99+
Length of the unique semi-axis (height) of the inflated hemispheroid
100+
parachute in meters.
99101
Parachute.porosity : float
100-
Porosity of the parachute material, which is a measure of how much air can
101-
pass through the parachute material.
102+
Porosity of the parachute is the ratio of open space in the canopy to total
103+
canopy area.
102104
"""
103105

104106
def __init__(
@@ -165,15 +167,16 @@ def __init__(
165167
passed to the trigger function. Default value is ``(0, 0, 0)``.
166168
Units are in Pa.
167169
parachute_radius : float, optional
168-
Radius of the inflated parachute. Default value is 1.5.
170+
Length of the non-unique semi-axis (radius) of the inflated hemispheroid
171+
parachute. Default value is 1.5.
169172
Units are in meters.
170173
parachute_height : float, optional
171-
Height of the inflated parachute. Default value is the radius parachute.
174+
Length of the unique semi-axis (height) of the inflated hemispheroid
175+
parachute. Default value is the radius of the parachute.
172176
Units are in meters.
173177
porosity : float, optional
174-
Porosity of the parachute material, which is a measure of how much air can
175-
pass through the parachute material.
176-
Default value is 0.0432 (for consistency with previous versions).
178+
Porosity of the parachute is the ratio of open space in the canopy to total
179+
canopy area. Default value is 0.0432 (for consistency with previous versions).
177180
"""
178181
self.name = name
179182
self.cd_s = cd_s

rocketpy/rocket/rocket.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1502,15 +1502,16 @@ def add_parachute(
15021502
passed to the trigger function. Default value is (0, 0, 0). Units
15031503
are in pascal.
15041504
parachute_radius : float, optional
1505-
Radius of the inflated parachute. Default value is 1.5.
1505+
Length of the non-unique semi-axis (radius) of the inflated hemispheroid
1506+
parachute. Default value is 1.5.
15061507
Units are in meters.
15071508
parachute_height : float, optional
1508-
Height of the inflated parachute. Default value is the radius parachute.
1509+
Length of the unique semi-axis (height) of the inflated hemispheroid
1510+
parachute. Default value is the radius of the parachute.
15091511
Units are in meters.
15101512
porosity : float, optional
1511-
Porosity of the parachute material, which is a measure of how much air can
1512-
pass through the parachute material.
1513-
Default value is 0.0432 (for consistency with previous versions).
1513+
Porosity of the parachute is the ratio of open space in the canopy to total
1514+
canopy area. Default value is 0.0432 (for consistency with previous versions).
15141515
15151516
Returns
15161517
-------

0 commit comments

Comments
 (0)