Skip to content

Commit

Permalink
DOC: Add initial and out-of-rail stability margins to Flight class do…
Browse files Browse the repository at this point in the history
…cumentation
  • Loading branch information
Gui-FernandesBR committed Mar 9, 2024
1 parent bd212d0 commit 2940138
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions rocketpy/simulation/flight.py
Original file line number Diff line number Diff line change
Expand Up @@ -426,6 +426,10 @@ class Flight:
Rocket's static margin during flight in calibers.
Flight.stability_margin : Function
Rocket's stability margin during flight, in calibers.
Flight.initial_stability_margin : float
Rocket's initial stability margin in calibers.
Flight.out_of_rail_stability_margin : float
Rocket's stability margin in calibers when it leaves the rail.
Flight.stream_velocity_x : Function
Freestream velocity x (East) component, in m/s, as a function of
time. Can be called or accessed as array.
Expand Down Expand Up @@ -2429,7 +2433,7 @@ def min_stability_margin(self):
@property
def initial_stability_margin(self):
"""Stability margin at time 0.
Returns
-------
float
Expand All @@ -2439,7 +2443,7 @@ def initial_stability_margin(self):
@property
def out_of_rail_stability_margin(self):
"""Stability margin at the time the rocket leaves the rail.
Returns
-------
float
Expand Down

0 comments on commit 2940138

Please sign in to comment.