pyBADA 0.1.1__py3-none-any.whl → 0.1.2__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. pyBADA/TCL.py +391 -341
  2. pyBADA/aircraft.py +81 -131
  3. pyBADA/bada3.py +269 -312
  4. pyBADA/bada4.py +212 -260
  5. pyBADA/badaH.py +84 -169
  6. pyBADA/configuration.py +60 -0
  7. {pybada-0.1.1.dist-info → pybada-0.1.2.dist-info}/METADATA +5 -7
  8. {pybada-0.1.1.dist-info → pybada-0.1.2.dist-info}/RECORD +11 -11
  9. {pybada-0.1.1.dist-info → pybada-0.1.2.dist-info}/WHEEL +1 -1
  10. {pybada-0.1.1.dist-info → pybada-0.1.2.dist-info}/licenses/AUTHORS +0 -0
  11. {pybada-0.1.1.dist-info → pybada-0.1.2.dist-info}/licenses/LICENCE.txt +0 -0
pyBADA/TCL.py CHANGED
@@ -80,6 +80,7 @@ def constantSpeedLevel(
80
80
  :param maxRFL: Maximum cruise altitude limit [ft]. Default is infinity.
81
81
  :param wS: Wind speed component along the longitudinal axis (positive for headwind, negative for tailwind) [kt]. Default is 0.0.
82
82
  :param turnMetrics: Dictionary containing turn parameters:
83
+
83
84
  - rateOfTurn [deg/s]
84
85
  - bankAngle [deg]
85
86
  - directionOfTurn {LEFT/RIGHT}. Default is no turn (straight flight).
@@ -87,12 +88,14 @@ def constantSpeedLevel(
87
88
  :param Lat: Geographical latitude of the starting point [deg].
88
89
  :param Lon: Geographical longitude of the starting point [deg].
89
90
  :param initialHeading: Dictionary defining the initial heading and its type:
91
+
90
92
  - magnetic: Magnetic heading [deg].
91
93
  - true: True heading [deg].
92
94
  - constantHeading: Whether to fly along a constant heading (loxodrome). Default is None.
93
95
  :param flightPhase: Defines the phase of flight, e.g., "Cruise", "Climb", "Descent". Default is "Cruise".
94
96
  :param magneticDeclinationGrid: Optional magnetic declination grid to correct headings. Default is None.
95
97
  :param kwargs: Additional optional parameters:
98
+
96
99
  - mass_const: Boolean. If True, keeps the aircraft mass constant during the segment. Default is False.
97
100
  - SOC_init: Initial battery state of charge for electric aircraft [%]. Default is 100 for BADAE.
98
101
  - speedBrakes: Dictionary defining whether speed brakes are deployed and their drag coefficient {deployed: False, value: 0.03}.
@@ -103,54 +106,50 @@ def constantSpeedLevel(
103
106
  - step_length: The step length for each iteration in [NM] or [s], depending on the lengthType. Default is 100 NM for BADA3/4 and 10 NM for BADAH/BADAE.
104
107
 
105
108
  :returns: A pandas DataFrame containing the flight trajectory with columns such as:
106
- - Hp: Altitude [ft]
107
- - TAS: True Air Speed [kt]
108
- - CAS: Calibrated Air Speed [kt]
109
- - GS: Ground Speed [kt]
110
- - M: Mach number [-]
111
- - ROCD: Rate of Climb/Descent [ft/min]
112
- - ESF: Energy Share Factor[-]
113
- - FUEL: Fuel flow [kg/s]
114
- - FUELCONSUMED: Total fuel consumed [kg]
115
- - THR: Thrust force [N]
116
- - DRAG: Drag force [N]
117
- - time: Elapsed time [s]
118
- - dist: Distance flown [NM]
119
- - slope: Trajectory slope [deg]
120
- - mass: Aircraft mass [kg]
121
- - config: Aerodynamic configuration
122
- - LAT: Latitude [deg]
123
- - LON: Longitude [deg]
124
- - HDGTrue: True heading [deg]
125
- - HDGMagnetic: Magnetic heading [deg]
126
- - BankAngle: Bank angle [deg]
127
- - ROT: Rate of turn [deg/s]
128
- - For BADAH:
129
- - Preq: Required power [W]
130
- - Peng: Generated power [W]
131
- - Pav: Available power [W]
132
- - For BADAE (electric aircraft):
133
- - Pmec: Mechanical power [W]
134
- - Pelc: Electrical power [W]
135
- - Pbat: Power supplied by the battery [W]
136
- - SOCr: Rate of battery state of charge depletion [%/h]
137
- - SOC: Battery state of charge [%]
138
- - Ibat: Battery current [A]
139
- - Vbat: Battery voltage [V]
140
- - Vgbat: Ground battery voltage [V]
141
- - Comment: Comments for each segment
109
+
110
+ - **Hp** - wAltitude [ft]
111
+ - **TAS** - True Air Speed [kt]
112
+ - **CAS** - Calibrated Air Speed [kt]
113
+ - **GS** - Ground Speed [kt]
114
+ - **M** - Mach number [-]
115
+ - **ROCD** - Rate of Climb/Descent [ft/min]
116
+ - **ESF** - Energy Share Factor [-]
117
+ - **FUEL** - Fuel flow [kg/s]
118
+ - **FUELCONSUMED** - Total fuel consumed [kg]
119
+ - **THR** - Thrust force [N]
120
+ - **DRAG** - Drag force [N]
121
+ - **time** - Elapsed time [s]
122
+ - **dist** - Distance flown [NM]
123
+ - **slope** - Trajectory slope [deg]
124
+ - **mass** - Aircraft mass [kg]
125
+ - **config** - Aerodynamic configuration
126
+ - **LAT** - Latitude [deg]
127
+ - **LON** - Longitude [deg]
128
+ - **HDGTrue** - True heading [deg]
129
+ - **HDGMagnetic** - Magnetic heading [deg]
130
+ - **BankAngle** - Bank angle [deg]
131
+ - **ROT** - Rate of turn [deg/s]
132
+ - **Comment** - Comments for each segment
133
+
134
+ - **For BADAH:**
135
+ - **Preq** - Required power [W]
136
+ - **Peng** - Generated power [W]
137
+ - **Pav** - Available power [W]
138
+
139
+ - **For BADAE (electric aircraft):**
140
+ - **Pmec** - Mechanical power [W]
141
+ - **Pelc** - Electrical power [W]
142
+ - **Pbat** - Power supplied by the battery [W]
143
+ - **SOCr** - Rate of battery state of charge depletion [%/h]
144
+ - **SOC** - Battery state of charge [%]
145
+ - **Ibat** - Battery current [A]
146
+ - **Vbat** - Battery voltage [V]
147
+ - **Vgbat** - Ground battery voltage [V]
142
148
  :rtype: pandas.DataFrame
143
149
 
144
150
  This function works by iteratively calculating the flight trajectory for a given segment of the flight,
145
151
  taking into account the specified flight conditions, and updating the aircraft’s state (altitude, speed, fuel, etc.)
146
152
  at each step of the iteration. The trajectory is returned as a DataFrame containing all relevant flight parameters.
147
-
148
- Key considerations:
149
- - Magnetic declination can be corrected based on the provided grid.
150
- - Supports handling turns and constant heading navigation.
151
- - Step climbs are optionally allowed if enabled.
152
- - Takes into account wind speed and flight phase-specific configurations.
153
- - Power and fuel consumption are calculated differently for each BADA family (BADAH and BADAE handle power instead of fuel in different ways).
154
153
  """
155
154
 
156
155
  rateOfTurn = turnMetrics["rateOfTurn"]
@@ -1208,12 +1207,14 @@ def constantSpeedROCD(
1208
1207
  :param DeltaTemp: Deviation from standard ISA temperature [K].
1209
1208
  :param wS: Wind speed component along the longitudinal axis [kt]. Positive values for headwind, negative for tailwind. Default is 0.0.
1210
1209
  :param turnMetrics: Dictionary defining turn parameters:
1210
+
1211
1211
  - rateOfTurn [deg/s]
1212
1212
  - bankAngle [deg]
1213
1213
  - directionOfTurn {LEFT/RIGHT}. Default is straight flight.
1214
1214
  :param Lat: Geographical latitude of the starting point [deg]. Default is None.
1215
1215
  :param Lon: Geographical longitude of the starting point [deg]. Default is None.
1216
1216
  :param initialHeading: Dictionary defining the initial heading (magnetic or true) and whether to fly a constant heading:
1217
+
1217
1218
  - magnetic: Magnetic heading [deg].
1218
1219
  - true: True heading [deg].
1219
1220
  - constantHeading: Whether to fly along a constant heading (loxodrome). Default is None.
@@ -1221,6 +1222,7 @@ def constantSpeedROCD(
1221
1222
  :param directionOfTurn: Direction of the turn {LEFT, RIGHT}. Default is None.
1222
1223
  :param magneticDeclinationGrid: Optional grid of magnetic declinations used to correct headings. Default is None.
1223
1224
  :param kwargs: Additional optional parameters:
1225
+
1224
1226
  - Hp_step: Altitude step size [ft]. Default is 1000 for BADA3/4, 500 for BADAH/BADAE.
1225
1227
  - SOC_init: Initial state of charge for electric aircraft [%]. Default is 100 for BADAE.
1226
1228
  - speedBrakes: Dictionary specifying whether speed brakes are deployed and their drag coefficient {deployed: False, value: 0.03}.
@@ -1229,43 +1231,46 @@ def constantSpeedROCD(
1229
1231
  - mass_const: Boolean specifying whether to keep the mass constant during the segment. Default is False.
1230
1232
  - m_iter: Number of iterations for the mass integration loop. Default is 5.
1231
1233
 
1232
- :returns: A pandas DataFrame containing the flight trajectory, including parameters like:
1233
- - Hp: Altitude [ft]
1234
- - TAS: True Air Speed [kt]
1235
- - CAS: Calibrated Air Speed [kt]
1236
- - GS: Ground Speed [kt]
1237
- - M: Mach number [-]
1238
- - ROCD: Rate of Climb/Descent [ft/min]
1239
- - ESF: Energy Share Factor [-]
1240
- - FUEL: Fuel flow [kg/s]
1241
- - FUELCONSUMED: Total fuel consumed [kg]
1242
- - THR: Thrust force [N]
1243
- - DRAG: Drag force [N]
1244
- - time: Elapsed time [s]
1245
- - dist: Distance flown [NM]
1246
- - slope: Trajectory slope [deg]
1247
- - mass: Aircraft mass [kg]
1248
- - config: Aerodynamic configuration
1249
- - LAT: Latitude [deg]
1250
- - LON: Longitude [deg]
1251
- - HDGTrue: True heading [deg]
1252
- - HDGMagnetic: Magnetic heading [deg]
1253
- - BankAngle: Bank angle [deg]
1254
- - ROT: Rate of turn [deg/s]
1255
- - For BADAH:
1256
- - Preq: Required power [W]
1257
- - Peng: Generated power [W]
1258
- - Pav: Available power [W]
1259
- - For BADAE (electric aircraft):
1260
- - Pmec: Mechanical power [W]
1261
- - Pelc: Electrical power [W]
1262
- - Pbat: Power supplied by the battery [W]
1263
- - SOCr: Rate of battery state of charge depletion [%/h]
1264
- - SOC: Battery state of charge [%]
1265
- - Ibat: Battery current [A]
1266
- - Vbat: Battery voltage [V]
1267
- - Vgbat: Ground battery voltage [V]
1268
- - Comment: Comments for each segment
1234
+ :returns: A pandas DataFrame containing the flight trajectory with columns such as:
1235
+
1236
+ - **Hp** - wAltitude [ft]
1237
+ - **TAS** - True Air Speed [kt]
1238
+ - **CAS** - Calibrated Air Speed [kt]
1239
+ - **GS** - Ground Speed [kt]
1240
+ - **M** - Mach number [-]
1241
+ - **ROCD** - Rate of Climb/Descent [ft/min]
1242
+ - **ESF** - Energy Share Factor [-]
1243
+ - **FUEL** - Fuel flow [kg/s]
1244
+ - **FUELCONSUMED** - Total fuel consumed [kg]
1245
+ - **THR** - Thrust force [N]
1246
+ - **DRAG** - Drag force [N]
1247
+ - **time** - Elapsed time [s]
1248
+ - **dist** - Distance flown [NM]
1249
+ - **slope** - Trajectory slope [deg]
1250
+ - **mass** - Aircraft mass [kg]
1251
+ - **config** - Aerodynamic configuration
1252
+ - **LAT** - Latitude [deg]
1253
+ - **LON** - Longitude [deg]
1254
+ - **HDGTrue** - True heading [deg]
1255
+ - **HDGMagnetic** - Magnetic heading [deg]
1256
+ - **BankAngle** - Bank angle [deg]
1257
+ - **ROT** - Rate of turn [deg/s]
1258
+ - **Comment** - Comments for each segment
1259
+
1260
+ - **For BADAH:**
1261
+ - **Preq** - Required power [W]
1262
+ - **Peng** - Generated power [W]
1263
+ - **Pav** - Available power [W]
1264
+
1265
+ - **For BADAE (electric aircraft):**
1266
+ - **Pmec** - Mechanical power [W]
1267
+ - **Pelc** - Electrical power [W]
1268
+ - **Pbat** - Power supplied by the battery [W]
1269
+ - **SOCr** - Rate of battery state of charge depletion [%/h]
1270
+ - **SOC** - Battery state of charge [%]
1271
+ - **Ibat** - Battery current [A]
1272
+ - **Vbat** - Battery voltage [V]
1273
+ - **Vgbat** - Ground battery voltage [V]
1269
1274
  :rtype: pandas.DataFrame
1270
1275
 
1271
1276
  Notes:
@@ -2216,12 +2221,14 @@ def constantSpeedROCD_time(
2216
2221
  :param DeltaTemp: Deviation from standard ISA temperature [K].
2217
2222
  :param wS: Wind speed component along the longitudinal axis [kt]. Default is 0.0.
2218
2223
  :param turnMetrics: Dictionary defining turn parameters:
2224
+
2219
2225
  - rateOfTurn [deg/s]
2220
2226
  - bankAngle [deg]
2221
2227
  - directionOfTurn {LEFT/RIGHT}. Default is straight flight.
2222
2228
  :param Lat: Geographical latitude at the start [deg]. Default is None.
2223
2229
  :param Lon: Geographical longitude at the start [deg]. Default is None.
2224
2230
  :param initialHeading: Dictionary defining the initial heading (magnetic or true) and whether to fly a constant heading:
2231
+
2225
2232
  - magnetic: Magnetic heading [deg].
2226
2233
  - true: True heading [deg].
2227
2234
  - constantHeading: Whether to fly along a constant heading (loxodrome). Default is None.
@@ -2229,6 +2236,7 @@ def constantSpeedROCD_time(
2229
2236
  :param directionOfTurn: Direction of the turn {LEFT, RIGHT}. Default is None.
2230
2237
  :param magneticDeclinationGrid: Optional grid of magnetic declinations used to correct headings. Default is None.
2231
2238
  :param kwargs: Additional optional parameters:
2239
+
2232
2240
  - step_length: Step size in seconds for time iteration. Default is 1 second.
2233
2241
  - SOC_init: Initial state of charge for electric aircraft [%]. Default is 100 for BADAE.
2234
2242
  - speedBrakes: Dictionary specifying whether speed brakes are deployed and their drag coefficient {deployed: False, value: 0.03}.
@@ -2237,43 +2245,46 @@ def constantSpeedROCD_time(
2237
2245
  - mass_const: Boolean specifying whether to keep the mass constant during the segment. Default is False.
2238
2246
  - m_iter: Number of iterations for the mass integration loop. Default is 5.
2239
2247
 
2240
- :returns: A pandas DataFrame containing the flight trajectory, including parameters like:
2241
- - Hp: Altitude [ft]
2242
- - TAS: True Air Speed [kt]
2243
- - CAS: Calibrated Air Speed [kt]
2244
- - GS: Ground Speed [kt]
2245
- - M: Mach number [-]
2246
- - ROCD: Rate of Climb/Descent [ft/min]
2247
- - ESF: Energy Share Factor [-]
2248
- - FUEL: Fuel flow [kg/s]
2249
- - FUELCONSUMED: Total fuel consumed [kg]
2250
- - THR: Thrust force [N]
2251
- - DRAG: Drag force [N]
2252
- - time: Elapsed time [s]
2253
- - dist: Distance flown [NM]
2254
- - slope: Trajectory slope [deg]
2255
- - mass: Aircraft mass [kg]
2256
- - config: Aerodynamic configuration
2257
- - LAT: Latitude [deg]
2258
- - LON: Longitude [deg]
2259
- - HDGTrue: True heading [deg]
2260
- - HDGMagnetic: Magnetic heading [deg]
2261
- - BankAngle: Bank angle [deg]
2262
- - ROT: Rate of turn [deg/s]
2263
- - For BADAH:
2264
- - Preq: Required power [W]
2265
- - Peng: Generated power [W]
2266
- - Pav: Available power [W]
2267
- - For BADAE (electric aircraft):
2268
- - Pmec: Mechanical power [W]
2269
- - Pelc: Electrical power [W]
2270
- - Pbat: Power supplied by the battery [W]
2271
- - SOCr: Rate of battery state of charge depletion [%/h]
2272
- - SOC: Battery state of charge [%]
2273
- - Ibat: Battery current [A]
2274
- - Vbat: Battery voltage [V]
2275
- - Vgbat: Ground battery voltage [V]
2276
- - Comment: Comments for each segment.
2248
+ :returns: A pandas DataFrame containing the flight trajectory with columns such as:
2249
+
2250
+ - **Hp** - wAltitude [ft]
2251
+ - **TAS** - True Air Speed [kt]
2252
+ - **CAS** - Calibrated Air Speed [kt]
2253
+ - **GS** - Ground Speed [kt]
2254
+ - **M** - Mach number [-]
2255
+ - **ROCD** - Rate of Climb/Descent [ft/min]
2256
+ - **ESF** - Energy Share Factor [-]
2257
+ - **FUEL** - Fuel flow [kg/s]
2258
+ - **FUELCONSUMED** - Total fuel consumed [kg]
2259
+ - **THR** - Thrust force [N]
2260
+ - **DRAG** - Drag force [N]
2261
+ - **time** - Elapsed time [s]
2262
+ - **dist** - Distance flown [NM]
2263
+ - **slope** - Trajectory slope [deg]
2264
+ - **mass** - Aircraft mass [kg]
2265
+ - **config** - Aerodynamic configuration
2266
+ - **LAT** - Latitude [deg]
2267
+ - **LON** - Longitude [deg]
2268
+ - **HDGTrue** - True heading [deg]
2269
+ - **HDGMagnetic** - Magnetic heading [deg]
2270
+ - **BankAngle** - Bank angle [deg]
2271
+ - **ROT** - Rate of turn [deg/s]
2272
+ - **Comment** - Comments for each segment
2273
+
2274
+ - **For BADAH:**
2275
+ - **Preq** - Required power [W]
2276
+ - **Peng** - Generated power [W]
2277
+ - **Pav** - Available power [W]
2278
+
2279
+ - **For BADAE (electric aircraft):**
2280
+ - **Pmec** - Mechanical power [W]
2281
+ - **Pelc** - Electrical power [W]
2282
+ - **Pbat** - Power supplied by the battery [W]
2283
+ - **SOCr** - Rate of battery state of charge depletion [%/h]
2284
+ - **SOC** - Battery state of charge [%]
2285
+ - **Ibat** - Battery current [A]
2286
+ - **Vbat** - Battery voltage [V]
2287
+ - **Vgbat** - Ground battery voltage [V]
2277
2288
  :rtype: pandas.DataFrame
2278
2289
  """
2279
2290
 
@@ -3201,12 +3212,14 @@ def constantSpeedSlope(
3201
3212
  :param DeltaTemp: Deviation from the standard ISA temperature [K].
3202
3213
  :param wS: Wind speed component along the longitudinal axis (affects ground speed) [kt]. Default is 0.0.
3203
3214
  :param turnMetrics: A dictionary defining the turn parameters:
3215
+
3204
3216
  - rateOfTurn [deg/s]
3205
3217
  - bankAngle [deg]
3206
3218
  - directionOfTurn {LEFT/RIGHT}. Default is straight flight.
3207
3219
  :param Lat: Initial latitude [deg]. Default is None.
3208
3220
  :param Lon: Initial longitude [deg]. Default is None.
3209
3221
  :param initialHeading: A dictionary defining the initial heading (magnetic or true) and whether to fly a constant heading:
3222
+
3210
3223
  - magnetic: Magnetic heading [deg].
3211
3224
  - true: True heading [deg].
3212
3225
  - constantHeading: Whether to maintain a constant heading. Default is None.
@@ -3214,6 +3227,7 @@ def constantSpeedSlope(
3214
3227
  :param directionOfTurn: Direction of the turn {LEFT, RIGHT}. Default is None.
3215
3228
  :param magneticDeclinationGrid: Optional grid of magnetic declination used to correct magnetic heading. Default is None.
3216
3229
  :param kwargs: Additional optional parameters:
3230
+
3217
3231
  - Hp_step: Step size in altitude for the iterative calculation [ft]. Default is 1000 ft for BADA3/BADA4, 500 ft for BADAH/BADAE.
3218
3232
  - SOC_init: Initial battery state of charge for electric aircraft (BADAE) [%]. Default is 100.
3219
3233
  - speedBrakes: A dictionary specifying whether speed brakes are deployed and the additional drag coefficient {deployed: False, value: 0.03}.
@@ -3222,43 +3236,46 @@ def constantSpeedSlope(
3222
3236
  - mass_const: Boolean indicating whether mass remains constant during the flight segment. Default is False.
3223
3237
  - m_iter: Number of iterations for the mass integration loop. Default is 5.
3224
3238
 
3225
- :returns: A pandas DataFrame containing flight trajectory data with the following columns:
3226
- - Hp: Pressure altitude [ft]
3227
- - TAS: True Air Speed [kt]
3228
- - CAS: Calibrated Air Speed [kt]
3229
- - GS: Ground Speed [kt]
3230
- - M: Mach number [-]
3231
- - ROCD: Rate of climb/descent [ft/min]
3232
- - ESF: Energy Share Factor [-]
3233
- - FUEL: Fuel flow [kg/s]
3234
- - FUELCONSUMED: Total fuel consumed [kg]
3235
- - THR: Thrust force [N]
3236
- - DRAG: Drag force [N]
3237
- - time: Elapsed time [s]
3238
- - dist: Distance flown [NM]
3239
- - slope: Flight trajectory slope (angle) [deg]
3240
- - mass: Aircraft mass [kg]
3241
- - config: Aerodynamic configuration
3242
- - LAT: Latitude [deg]
3243
- - LON: Longitude [deg]
3244
- - HDGTrue: True heading [deg]
3245
- - HDGMagnetic: Magnetic heading [deg]
3246
- - BankAngle: Bank angle during the turn [deg]
3247
- - ROT: Rate of turn [deg/s]
3248
- - Comment: Comments describing the flight segment
3249
- - For BADAH:
3250
- - Preq: Required power for level flight [W]
3251
- - Peng: Generated power [W]
3252
- - Pav: Available power [W]
3253
- - For BADAE (electric aircraft):
3254
- - Pmec: Mechanical power [W]
3255
- - Pelc: Electrical power [W]
3256
- - Pbat: Battery power [W]
3257
- - SOCr: Rate of battery state of charge depletion [%/h]
3258
- - SOC: Battery state of charge [%]
3259
- - Ibat: Battery current [A]
3260
- - Vbat: Battery voltage [V]
3261
- - Vgbat: Ground battery voltage [V]
3239
+ :returns: A pandas DataFrame containing the flight trajectory with columns such as:
3240
+
3241
+ - **Hp** - wAltitude [ft]
3242
+ - **TAS** - True Air Speed [kt]
3243
+ - **CAS** - Calibrated Air Speed [kt]
3244
+ - **GS** - Ground Speed [kt]
3245
+ - **M** - Mach number [-]
3246
+ - **ROCD** - Rate of Climb/Descent [ft/min]
3247
+ - **ESF** - Energy Share Factor [-]
3248
+ - **FUEL** - Fuel flow [kg/s]
3249
+ - **FUELCONSUMED** - Total fuel consumed [kg]
3250
+ - **THR** - Thrust force [N]
3251
+ - **DRAG** - Drag force [N]
3252
+ - **time** - Elapsed time [s]
3253
+ - **dist** - Distance flown [NM]
3254
+ - **slope** - Trajectory slope [deg]
3255
+ - **mass** - Aircraft mass [kg]
3256
+ - **config** - Aerodynamic configuration
3257
+ - **LAT** - Latitude [deg]
3258
+ - **LON** - Longitude [deg]
3259
+ - **HDGTrue** - True heading [deg]
3260
+ - **HDGMagnetic** - Magnetic heading [deg]
3261
+ - **BankAngle** - Bank angle [deg]
3262
+ - **ROT** - Rate of turn [deg/s]
3263
+ - **Comment** - Comments for each segment
3264
+
3265
+ - **For BADAH:**
3266
+ - **Preq** - Required power [W]
3267
+ - **Peng** - Generated power [W]
3268
+ - **Pav** - Available power [W]
3269
+
3270
+ - **For BADAE (electric aircraft):**
3271
+ - **Pmec** - Mechanical power [W]
3272
+ - **Pelc** - Electrical power [W]
3273
+ - **Pbat** - Power supplied by the battery [W]
3274
+ - **SOCr** - Rate of battery state of charge depletion [%/h]
3275
+ - **SOC** - Battery state of charge [%]
3276
+ - **Ibat** - Battery current [A]
3277
+ - **Vbat** - Battery voltage [V]
3278
+ - **Vgbat** - Ground battery voltage [V]
3262
3279
  :rtype: pandas.DataFrame
3263
3280
  """
3264
3281
 
@@ -4198,12 +4215,14 @@ def constantSpeedSlope_time(
4198
4215
  :param DeltaTemp: Deviation from standard ISA temperature [K].
4199
4216
  :param wS: Longitudinal wind speed component (affects ground speed) [kt]. Default is 0.0.
4200
4217
  :param turnMetrics: A dictionary defining the turn parameters:
4218
+
4201
4219
  - rateOfTurn [deg/s]
4202
4220
  - bankAngle [deg]
4203
4221
  - directionOfTurn {LEFT/RIGHT}. Default is straight flight.
4204
4222
  :param Lat: Initial latitude [deg]. Default is None.
4205
4223
  :param Lon: Initial longitude [deg]. Default is None.
4206
4224
  :param initialHeading: A dictionary specifying the initial heading (magnetic or true) and whether to fly a constant heading:
4225
+
4207
4226
  - magnetic: Magnetic heading [deg].
4208
4227
  - true: True heading [deg].
4209
4228
  - constantHeading: Whether to maintain a constant heading [True/False].
@@ -4211,6 +4230,7 @@ def constantSpeedSlope_time(
4211
4230
  :param directionOfTurn: Direction of turn {LEFT, RIGHT}. Default is None.
4212
4231
  :param magneticDeclinationGrid: Optional magnetic declination grid for correcting magnetic heading. Default is None.
4213
4232
  :param kwargs: Additional optional parameters:
4233
+
4214
4234
  - step_length: Step length for trajectory calculation [s]. Default is 1 second.
4215
4235
  - Hp_step: Altitude step size for calculations [ft]. Default is 1000 ft for BADA3/BADA4, 500 ft for BADAH/BADAE.
4216
4236
  - SOC_init: Initial battery state of charge (for electric aircraft) [%]. Default is 100.
@@ -4220,44 +4240,46 @@ def constantSpeedSlope_time(
4220
4240
  - mass_const: Boolean indicating whether mass remains constant during the flight. Default is False.
4221
4241
  - m_iter: Number of iterations for mass integration. Default is 5.
4222
4242
 
4223
- :returns: A pandas DataFrame containing the flight trajectory data with the following columns:
4224
- - Hp: Pressure altitude [ft]
4225
- - TAS: True Air Speed [kt]
4226
- - CAS: Calibrated Air Speed [kt]
4227
- - GS: Ground Speed [kt]
4228
- - M: Mach number [-]
4229
- - ROCD: Rate of Climb/Descent [ft/min]
4230
- - ESF: Energy Share Factor [-]
4231
- - FUEL: Fuel flow [kg/s]
4232
- - FUELCONSUMED: Total fuel consumed [kg]
4233
- - THR: Thrust force [N]
4234
- - DRAG: Drag force [N]
4235
- - time: Elapsed time [s]
4236
- - dist: Distance flown [NM]
4237
- - slope: Trajectory slope (angle) [deg]
4238
- - mass: Aircraft mass [kg]
4239
- - config: Aerodynamic configuration
4240
- - LAT: Latitude [deg]
4241
- - LON: Longitude [deg]
4242
- - HDGTrue: True heading [deg]
4243
- - HDGMagnetic: Magnetic heading [deg]
4244
- - BankAngle: Bank angle during turns [deg]
4245
- - ROT: Rate of turn [deg/s]
4246
- - Comment: Descriptive comments about the trajectory segment.
4247
- - For BADAH:
4248
- - Preq: Power required for level flight [W]
4249
- - Peng: Generated power [W]
4250
- - Pav: Available power [W]
4251
- - For BADAE (electric aircraft):
4252
- - Pmec: Mechanical power [W]
4253
- - Pelc: Electrical power [W]
4254
- - Pbat: Battery power [W]
4255
- - SOCr: Battery state of charge rate of depletion [%/h]
4256
- - SOC: Battery state of charge [%]
4257
- - Ibat: Battery current [A]
4258
- - Vbat: Battery voltage [V]
4259
- - Vgbat: Ground battery voltage [V]
4243
+ :returns: A pandas DataFrame containing the flight trajectory with columns such as:
4260
4244
 
4245
+ - **Hp** - wAltitude [ft]
4246
+ - **TAS** - True Air Speed [kt]
4247
+ - **CAS** - Calibrated Air Speed [kt]
4248
+ - **GS** - Ground Speed [kt]
4249
+ - **M** - Mach number [-]
4250
+ - **ROCD** - Rate of Climb/Descent [ft/min]
4251
+ - **ESF** - Energy Share Factor [-]
4252
+ - **FUEL** - Fuel flow [kg/s]
4253
+ - **FUELCONSUMED** - Total fuel consumed [kg]
4254
+ - **THR** - Thrust force [N]
4255
+ - **DRAG** - Drag force [N]
4256
+ - **time** - Elapsed time [s]
4257
+ - **dist** - Distance flown [NM]
4258
+ - **slope** - Trajectory slope [deg]
4259
+ - **mass** - Aircraft mass [kg]
4260
+ - **config** - Aerodynamic configuration
4261
+ - **LAT** - Latitude [deg]
4262
+ - **LON** - Longitude [deg]
4263
+ - **HDGTrue** - True heading [deg]
4264
+ - **HDGMagnetic** - Magnetic heading [deg]
4265
+ - **BankAngle** - Bank angle [deg]
4266
+ - **ROT** - Rate of turn [deg/s]
4267
+ - **Comment** - Comments for each segment
4268
+
4269
+ - **For BADAH:**
4270
+ - **Preq** - Required power [W]
4271
+ - **Peng** - Generated power [W]
4272
+ - **Pav** - Available power [W]
4273
+
4274
+ - **For BADAE (electric aircraft):**
4275
+ - **Pmec** - Mechanical power [W]
4276
+ - **Pelc** - Electrical power [W]
4277
+ - **Pbat** - Power supplied by the battery [W]
4278
+ - **SOCr** - Rate of battery state of charge depletion [%/h]
4279
+ - **SOC** - Battery state of charge [%]
4280
+ - **Ibat** - Battery current [A]
4281
+ - **Vbat** - Battery voltage [V]
4282
+ - **Vgbat** - Ground battery voltage [V]
4261
4283
  :rtype: pandas.DataFrame
4262
4284
  """
4263
4285
 
@@ -5193,12 +5215,14 @@ def constantSpeedRating(
5193
5215
  :param DeltaTemp: Deviation from the standard ISA temperature [K].
5194
5216
  :param wS: Wind speed component along the longitudinal axis (affects ground speed) [kt]. Default is 0.0.
5195
5217
  :param turnMetrics: A dictionary defining the turn parameters:
5218
+
5196
5219
  - rateOfTurn [deg/s]
5197
5220
  - bankAngle [deg]
5198
5221
  - directionOfTurn {LEFT/RIGHT}. Default is straight flight.
5199
5222
  :param Lat: Initial latitude [deg]. Default is None.
5200
5223
  :param Lon: Initial longitude [deg]. Default is None.
5201
5224
  :param initialHeading: A dictionary defining the initial heading (magnetic or true) and whether to fly a constant heading:
5225
+
5202
5226
  - magnetic: Magnetic heading [deg].
5203
5227
  - true: True heading [deg].
5204
5228
  - constantHeading: Whether to maintain a constant heading. Default is None.
@@ -5207,6 +5231,7 @@ def constantSpeedRating(
5207
5231
  :param expedite: Boolean flag to expedite climb/descent. Default is False.
5208
5232
  :param magneticDeclinationGrid: Optional grid of magnetic declination used to correct magnetic heading. Default is None.
5209
5233
  :param kwargs: Additional optional parameters:
5234
+
5210
5235
  - Hp_step: Step size in altitude for the iterative calculation [ft]. Default is 1000 ft for BADA3/BADA4, 500 ft for BADAH/BADAE.
5211
5236
  - SOC_init: Initial battery state of charge for electric aircraft (BADAE) [%]. Default is 100.
5212
5237
  - speedBrakes: A dictionary specifying whether speed brakes are deployed and the additional drag coefficient {deployed: False, value: 0.03}.
@@ -5215,43 +5240,46 @@ def constantSpeedRating(
5215
5240
  - mass_const: Boolean indicating whether mass remains constant during the flight segment. Default is False.
5216
5241
  - m_iter: Number of iterations for the mass integration loop. Default is 5.
5217
5242
 
5218
- :returns: A pandas DataFrame containing flight trajectory data with the following columns:
5219
- - Hp: Pressure altitude [ft]
5220
- - TAS: True Air Speed [kt]
5221
- - CAS: Calibrated Air Speed [kt]
5222
- - GS: Ground Speed [kt]
5223
- - M: Mach number [-]
5224
- - ROCD: Rate of climb/descent [ft/min]
5225
- - ESF: Energy Share Factor [-]
5226
- - FUEL: Fuel flow [kg/s]
5227
- - FUELCONSUMED: Total fuel consumed [kg]
5228
- - THR: Thrust force [N]
5229
- - DRAG: Drag force [N]
5230
- - time: Elapsed time [s]
5231
- - dist: Distance flown [NM]
5232
- - slope: Flight trajectory slope (angle) [deg]
5233
- - mass: Aircraft mass [kg]
5234
- - config: Aerodynamic configuration
5235
- - LAT: Latitude [deg]
5236
- - LON: Longitude [deg]
5237
- - HDGTrue: True heading [deg]
5238
- - HDGMagnetic: Magnetic heading [deg]
5239
- - BankAngle: Bank angle during the turn [deg]
5240
- - ROT: Rate of turn [deg/s]
5241
- - Comment: Comments describing the flight segment
5242
- - For BADAH:
5243
- - Preq: Required power for level flight [W]
5244
- - Peng: Generated power [W]
5245
- - Pav: Available power [W]
5246
- - For BADAE (electric aircraft):
5247
- - Pmec: Mechanical power [W]
5248
- - Pelc: Electrical power [W]
5249
- - Pbat: Battery power [W]
5250
- - SOCr: Rate of battery state of charge depletion [%/h]
5251
- - SOC: Battery state of charge [%]
5252
- - Ibat: Battery current [A]
5253
- - Vbat: Battery voltage [V]
5254
- - Vgbat: Ground battery voltage [V]
5243
+ :returns: A pandas DataFrame containing the flight trajectory with columns such as:
5244
+
5245
+ - **Hp** - wAltitude [ft]
5246
+ - **TAS** - True Air Speed [kt]
5247
+ - **CAS** - Calibrated Air Speed [kt]
5248
+ - **GS** - Ground Speed [kt]
5249
+ - **M** - Mach number [-]
5250
+ - **ROCD** - Rate of Climb/Descent [ft/min]
5251
+ - **ESF** - Energy Share Factor [-]
5252
+ - **FUEL** - Fuel flow [kg/s]
5253
+ - **FUELCONSUMED** - Total fuel consumed [kg]
5254
+ - **THR** - Thrust force [N]
5255
+ - **DRAG** - Drag force [N]
5256
+ - **time** - Elapsed time [s]
5257
+ - **dist** - Distance flown [NM]
5258
+ - **slope** - Trajectory slope [deg]
5259
+ - **mass** - Aircraft mass [kg]
5260
+ - **config** - Aerodynamic configuration
5261
+ - **LAT** - Latitude [deg]
5262
+ - **LON** - Longitude [deg]
5263
+ - **HDGTrue** - True heading [deg]
5264
+ - **HDGMagnetic** - Magnetic heading [deg]
5265
+ - **BankAngle** - Bank angle [deg]
5266
+ - **ROT** - Rate of turn [deg/s]
5267
+ - **Comment** - Comments for each segment
5268
+
5269
+ - **For BADAH:**
5270
+ - **Preq** - Required power [W]
5271
+ - **Peng** - Generated power [W]
5272
+ - **Pav** - Available power [W]
5273
+
5274
+ - **For BADAE (electric aircraft):**
5275
+ - **Pmec** - Mechanical power [W]
5276
+ - **Pelc** - Electrical power [W]
5277
+ - **Pbat** - Power supplied by the battery [W]
5278
+ - **SOCr** - Rate of battery state of charge depletion [%/h]
5279
+ - **SOC** - Battery state of charge [%]
5280
+ - **Ibat** - Battery current [A]
5281
+ - **Vbat** - Battery voltage [V]
5282
+ - **Vgbat** - Ground battery voltage [V]
5255
5283
  :rtype: pandas.DataFrame
5256
5284
  """
5257
5285
 
@@ -6109,12 +6137,14 @@ def constantSpeedRating_time(
6109
6137
  :param DeltaTemp: Deviation from the standard ISA temperature [K].
6110
6138
  :param wS: Wind speed component along the longitudinal axis (affects ground speed) [kt]. Default is 0.0.
6111
6139
  :param turnMetrics: A dictionary defining the turn parameters:
6140
+
6112
6141
  - rateOfTurn [deg/s]
6113
6142
  - bankAngle [deg]
6114
6143
  - directionOfTurn {LEFT/RIGHT}. Default is straight flight.
6115
6144
  :param Lat: Initial latitude [deg]. Default is None.
6116
6145
  :param Lon: Initial longitude [deg]. Default is None.
6117
6146
  :param initialHeading: A dictionary defining the initial heading (magnetic or true) and whether to fly a constant heading:
6147
+
6118
6148
  - magnetic: Magnetic heading [deg].
6119
6149
  - true: True heading [deg].
6120
6150
  - constantHeading: Whether to maintain a constant heading. Default is None.
@@ -6124,6 +6154,7 @@ def constantSpeedRating_time(
6124
6154
  :param magneticDeclinationGrid: Optional grid of magnetic declination used to correct magnetic heading. Default is None.
6125
6155
  :param initRating: Initial engine rating settings. Default is None.
6126
6156
  :param kwargs: Additional optional parameters:
6157
+
6127
6158
  - step_length: Step size in time for the iterative calculation [s]. Default is 1 s.
6128
6159
  - SOC_init: Initial battery state of charge for electric aircraft (BADAE) [%]. Default is 100.
6129
6160
  - speedBrakes: A dictionary specifying whether speed brakes are deployed and the additional drag coefficient {deployed: False, value: 0.03}.
@@ -6132,43 +6163,46 @@ def constantSpeedRating_time(
6132
6163
  - mass_const: Boolean indicating whether mass remains constant during the flight segment. Default is False.
6133
6164
  - m_iter: Number of iterations for the mass integration loop. Default is 5.
6134
6165
 
6135
- :returns: A pandas DataFrame containing flight trajectory data with the following columns:
6136
- - Hp: Pressure altitude [ft]
6137
- - TAS: True Air Speed [kt]
6138
- - CAS: Calibrated Air Speed [kt]
6139
- - GS: Ground Speed [kt]
6140
- - M: Mach number [-]
6141
- - ROCD: Rate of climb/descent [ft/min]
6142
- - ESF: Energy Share Factor [-]
6143
- - FUEL: Fuel flow [kg/s]
6144
- - FUELCONSUMED: Total fuel consumed [kg]
6145
- - THR: Thrust force [N]
6146
- - DRAG: Drag force [N]
6147
- - time: Elapsed time [s]
6148
- - dist: Distance flown [NM]
6149
- - slope: Flight trajectory slope (angle) [deg]
6150
- - mass: Aircraft mass [kg]
6151
- - config: Aerodynamic configuration
6152
- - LAT: Latitude [deg]
6153
- - LON: Longitude [deg]
6154
- - HDGTrue: True heading [deg]
6155
- - HDGMagnetic: Magnetic heading [deg]
6156
- - BankAngle: Bank angle during the turn [deg]
6157
- - ROT: Rate of turn [deg/s]
6158
- - Comment: Comments describing the flight segment
6159
- - For BADAH:
6160
- - Preq: Required power for level flight [W]
6161
- - Peng: Generated power [W]
6162
- - Pav: Available power [W]
6163
- - For BADAE (electric aircraft):
6164
- - Pmec: Mechanical power [W]
6165
- - Pelc: Electrical power [W]
6166
- - Pbat: Battery power [W]
6167
- - SOCr: Rate of battery state of charge depletion [%/h]
6168
- - SOC: Battery state of charge [%]
6169
- - Ibat: Battery current [A]
6170
- - Vbat: Battery voltage [V]
6171
- - Vgbat: Ground battery voltage [V]
6166
+ :returns: A pandas DataFrame containing the flight trajectory with columns such as:
6167
+
6168
+ - **Hp** - wAltitude [ft]
6169
+ - **TAS** - True Air Speed [kt]
6170
+ - **CAS** - Calibrated Air Speed [kt]
6171
+ - **GS** - Ground Speed [kt]
6172
+ - **M** - Mach number [-]
6173
+ - **ROCD** - Rate of Climb/Descent [ft/min]
6174
+ - **ESF** - Energy Share Factor [-]
6175
+ - **FUEL** - Fuel flow [kg/s]
6176
+ - **FUELCONSUMED** - Total fuel consumed [kg]
6177
+ - **THR** - Thrust force [N]
6178
+ - **DRAG** - Drag force [N]
6179
+ - **time** - Elapsed time [s]
6180
+ - **dist** - Distance flown [NM]
6181
+ - **slope** - Trajectory slope [deg]
6182
+ - **mass** - Aircraft mass [kg]
6183
+ - **config** - Aerodynamic configuration
6184
+ - **LAT** - Latitude [deg]
6185
+ - **LON** - Longitude [deg]
6186
+ - **HDGTrue** - True heading [deg]
6187
+ - **HDGMagnetic** - Magnetic heading [deg]
6188
+ - **BankAngle** - Bank angle [deg]
6189
+ - **ROT** - Rate of turn [deg/s]
6190
+ - **Comment** - Comments for each segment
6191
+
6192
+ - **For BADAH:**
6193
+ - **Preq** - Required power [W]
6194
+ - **Peng** - Generated power [W]
6195
+ - **Pav** - Available power [W]
6196
+
6197
+ - **For BADAE (electric aircraft):**
6198
+ - **Pmec** - Mechanical power [W]
6199
+ - **Pelc** - Electrical power [W]
6200
+ - **Pbat** - Power supplied by the battery [W]
6201
+ - **SOCr** - Rate of battery state of charge depletion [%/h]
6202
+ - **SOC** - Battery state of charge [%]
6203
+ - **Ibat** - Battery current [A]
6204
+ - **Vbat** - Battery voltage [V]
6205
+ - **Vgbat** - Ground battery voltage [V]
6172
6206
  :rtype: pandas.DataFrame
6173
6207
  """
6174
6208
 
@@ -7006,6 +7040,7 @@ def accDec(
7006
7040
 
7007
7041
  .. note::
7008
7042
  The control law used during the segment depends on the targets provided in the input parameter 'control':
7043
+
7009
7044
  - ROCD/slope+ESF: Law based on ROCD/slope + ESF
7010
7045
  - ROCD/slope+acc: Law based on ROCD/slope + acceleration
7011
7046
  - ROCD/slope only: Law based on rating + ROCD/slope
@@ -7019,6 +7054,7 @@ def accDec(
7019
7054
  :param v_final: Final speed [kt] (CAS/TAS) or [-] MACH.
7020
7055
  :param phase: Vertical evolution phase {Climb, Descent, Cruise}.
7021
7056
  :param control: A dictionary containing the following targets:
7057
+
7022
7058
  - ROCDtarget: Rate of climb/descent to be followed [ft/min].
7023
7059
  - slopetarget: Slope (flight path angle) to be followed [deg].
7024
7060
  - acctarget: Acceleration to be followed [m/s^2].
@@ -7028,61 +7064,67 @@ def accDec(
7028
7064
  :param DeltaTemp: Deviation from the standard ISA temperature [K].
7029
7065
  :param wS: Wind speed component along the longitudinal axis (affects ground speed) [kt]. Default is 0.0.
7030
7066
  :param turnMetrics: A dictionary defining turn parameters:
7067
+
7031
7068
  - rateOfTurn [deg/s]
7032
7069
  - bankAngle [deg]
7033
7070
  - directionOfTurn {LEFT/RIGHT}. Default is straight flight.
7034
7071
  :param Lat: Initial latitude [deg]. Default is None.
7035
7072
  :param Lon: Initial longitude [deg]. Default is None.
7036
7073
  :param initialHeading: A dictionary defining the initial heading (magnetic or true) and whether to fly a constant heading:
7074
+
7037
7075
  - magnetic: Magnetic heading [deg].
7038
7076
  - true: True heading [deg].
7039
7077
  - constantHeading: Whether to maintain a constant heading. Default is None.
7040
7078
  :param reducedPower: Boolean specifying if reduced power is applied during the climb. Default is None.
7041
7079
  :param magneticDeclinationGrid: Optional grid of magnetic declination used to correct magnetic heading. Default is None.
7042
7080
  :param kwargs: Additional optional parameters:
7081
+
7043
7082
  - speed_step: Speed step size for the iterative calculation [-] for M, [kt] for TAS/CAS. Default is 0.01 Mach, 5 kt for TAS/CAS.
7044
7083
  - SOC_init: Initial battery state of charge for electric aircraft (BADAE) [%]. Default is 100.
7045
7084
  - config: Default aerodynamic configuration (TO, IC, CR, AP, LD). Default is None.
7046
7085
  - mass_const: Boolean indicating whether mass remains constant during the flight segment. Default is False.
7047
7086
  - m_iter: Number of iterations for the mass integration loop. Default is 10 for BADA3/4/H, 5 for BADAE.
7048
- :returns: A pandas DataFrame containing flight trajectory data with the following columns:
7049
- - Hp: Pressure altitude [ft]
7050
- - TAS: True Air Speed [kt]
7051
- - CAS: Calibrated Air Speed [kt]
7052
- - GS: Ground Speed [kt]
7053
- - M: Mach number [-]
7054
- - acc: Acceleration rate [m/s^2]
7055
- - ROCD: Rate of climb/descent [ft/min]
7056
- - ESF: Energy Share Factor [-]
7057
- - FUEL: Fuel flow [kg/s]
7058
- - FUELCONSUMED: Total fuel consumed [kg]
7059
- - THR: Thrust force [N]
7060
- - DRAG: Drag force [N]
7061
- - time: Elapsed time [s]
7062
- - dist: Distance flown [NM]
7063
- - slope: Flight trajectory slope (angle) [deg]
7064
- - mass: Aircraft mass [kg]
7065
- - config: Aerodynamic configuration
7066
- - LAT: Latitude [deg]
7067
- - LON: Longitude [deg]
7068
- - HDGTrue: True heading [deg]
7069
- - HDGMagnetic: Magnetic heading [deg]
7070
- - BankAngle: Bank angle during the turn [deg]
7071
- - ROT: Rate of turn [deg/s]
7072
- - Comment: Comments describing the flight segment
7073
- - For BADAH:
7074
- - Preq: Required power for level flight [W]
7075
- - Peng: Generated power [W]
7076
- - Pav: Available power [W]
7077
- - For BADAE (electric aircraft):
7078
- - Pmec: Mechanical power [W]
7079
- - Pelc: Electrical power [W]
7080
- - Pbat: Battery power [W]
7081
- - SOCr: Rate of battery state of charge depletion [%/h]
7082
- - SOC: Battery state of charge [%]
7083
- - Ibat: Battery current [A]
7084
- - Vbat: Battery voltage [V]
7085
- - Vgbat: Ground battery voltage [V]
7087
+
7088
+ :returns: A pandas DataFrame containing the flight trajectory with columns such as:
7089
+
7090
+ - **Hp** - wAltitude [ft]
7091
+ - **TAS** - True Air Speed [kt]
7092
+ - **CAS** - Calibrated Air Speed [kt]
7093
+ - **GS** - Ground Speed [kt]
7094
+ - **M** - Mach number [-]
7095
+ - **ROCD** - Rate of Climb/Descent [ft/min]
7096
+ - **ESF** - Energy Share Factor [-]
7097
+ - **FUEL** - Fuel flow [kg/s]
7098
+ - **FUELCONSUMED** - Total fuel consumed [kg]
7099
+ - **THR** - Thrust force [N]
7100
+ - **DRAG** - Drag force [N]
7101
+ - **time** - Elapsed time [s]
7102
+ - **dist** - Distance flown [NM]
7103
+ - **slope** - Trajectory slope [deg]
7104
+ - **mass** - Aircraft mass [kg]
7105
+ - **config** - Aerodynamic configuration
7106
+ - **LAT** - Latitude [deg]
7107
+ - **LON** - Longitude [deg]
7108
+ - **HDGTrue** - True heading [deg]
7109
+ - **HDGMagnetic** - Magnetic heading [deg]
7110
+ - **BankAngle** - Bank angle [deg]
7111
+ - **ROT** - Rate of turn [deg/s]
7112
+ - **Comment** - Comments for each segment
7113
+
7114
+ - **For BADAH:**
7115
+ - **Preq** - Required power [W]
7116
+ - **Peng** - Generated power [W]
7117
+ - **Pav** - Available power [W]
7118
+
7119
+ - **For BADAE (electric aircraft):**
7120
+ - **Pmec** - Mechanical power [W]
7121
+ - **Pelc** - Electrical power [W]
7122
+ - **Pbat** - Power supplied by the battery [W]
7123
+ - **SOCr** - Rate of battery state of charge depletion [%/h]
7124
+ - **SOC** - Battery state of charge [%]
7125
+ - **Ibat** - Battery current [A]
7126
+ - **Vbat** - Battery voltage [V]
7127
+ - **Vgbat** - Ground battery voltage [V]
7086
7128
  :rtype: pandas.DataFrame
7087
7129
  """
7088
7130
 
@@ -8274,6 +8316,7 @@ def accDec_time(
8274
8316
 
8275
8317
  .. note::
8276
8318
  The control law used during the segment depends on the targets provided in the input parameter 'control':
8319
+
8277
8320
  - ROCD/slope+ESF: Law based on ROCD/slope + ESF
8278
8321
  - ROCD/slope+acc: Law based on ROCD/slope + acceleration
8279
8322
  - ROCD/slope only: Law based on rating + ROCD/slope
@@ -8288,6 +8331,7 @@ def accDec_time(
8288
8331
  :param speedEvol: Evolution of speed {acc, dec} (acceleration or deceleration).
8289
8332
  :param phase: Vertical evolution phase {Climb, Descent, Cruise}.
8290
8333
  :param control: A dictionary containing the following targets:
8334
+
8291
8335
  - ROCDtarget: Rate of climb/descent to be followed [ft/min].
8292
8336
  - slopetarget: Slope (flight path angle) to be followed [deg].
8293
8337
  - acctarget: Acceleration to be followed [m/s^2].
@@ -8297,61 +8341,67 @@ def accDec_time(
8297
8341
  :param DeltaTemp: Deviation from the standard ISA temperature [K].
8298
8342
  :param wS: Wind speed component along the longitudinal axis (affects ground speed) [kt]. Default is 0.0.
8299
8343
  :param turnMetrics: A dictionary defining turn parameters:
8344
+
8300
8345
  - rateOfTurn [deg/s]
8301
8346
  - bankAngle [deg]
8302
8347
  - directionOfTurn {LEFT/RIGHT}. Default is straight flight.
8303
8348
  :param Lat: Initial latitude [deg]. Default is None.
8304
8349
  :param Lon: Initial longitude [deg]. Default is None.
8305
8350
  :param initialHeading: A dictionary defining the initial heading (magnetic or true) and whether to fly a constant heading:
8351
+
8306
8352
  - magnetic: Magnetic heading [deg].
8307
8353
  - true: True heading [deg].
8308
8354
  - constantHeading: Whether to maintain a constant heading. Default is None.
8309
8355
  :param reducedPower: Boolean specifying if reduced power is applied during the climb. Default is None.
8310
8356
  :param magneticDeclinationGrid: Optional grid of magnetic declination used to correct magnetic heading. Default is None.
8311
8357
  :param kwargs: Additional optional parameters:
8358
+
8312
8359
  - step_length: Length of each time step in the calculation [s]. Default is 1 second.
8313
8360
  - SOC_init: Initial battery state of charge for electric aircraft (BADAE) [%]. Default is 100.
8314
8361
  - config: Default aerodynamic configuration (TO, IC, CR, AP, LD). Default is None.
8315
8362
  - mass_const: Boolean indicating whether mass remains constant during the flight segment. Default is False.
8316
8363
  - m_iter: Number of iterations for the mass integration loop. Default is 10 for BADA3/4/H, 5 for BADAE.
8317
- :returns: A pandas DataFrame containing flight trajectory data with the following columns:
8318
- - Hp: Pressure altitude [ft]
8319
- - TAS: True Air Speed [kt]
8320
- - CAS: Calibrated Air Speed [kt]
8321
- - GS: Ground Speed [kt]
8322
- - M: Mach number [-]
8323
- - acc: Acceleration rate [m/s^2]
8324
- - ROCD: Rate of climb/descent [ft/min]
8325
- - ESF: Energy Share Factor [-]
8326
- - FUEL: Fuel flow [kg/s]
8327
- - FUELCONSUMED: Total fuel consumed [kg]
8328
- - THR: Thrust force [N]
8329
- - DRAG: Drag force [N]
8330
- - time: Elapsed time [s]
8331
- - dist: Distance flown [NM]
8332
- - slope: Flight trajectory slope (angle) [deg]
8333
- - mass: Aircraft mass [kg]
8334
- - config: Aerodynamic configuration
8335
- - LAT: Latitude [deg]
8336
- - LON: Longitude [deg]
8337
- - HDGTrue: True heading [deg]
8338
- - HDGMagnetic: Magnetic heading [deg]
8339
- - BankAngle: Bank angle during the turn [deg]
8340
- - ROT: Rate of turn [deg/s]
8341
- - Comment: Comments describing the flight segment
8342
- - For BADAH:
8343
- - Preq: Required power for level flight [W]
8344
- - Peng: Generated power [W]
8345
- - Pav: Available power [W]
8346
- - For BADAE (electric aircraft):
8347
- - Pmec: Mechanical power [W]
8348
- - Pelc: Electrical power [W]
8349
- - Pbat: Battery power [W]
8350
- - SOCr: Rate of battery state of charge depletion [%/h]
8351
- - SOC: Battery state of charge [%]
8352
- - Ibat: Battery current [A]
8353
- - Vbat: Battery voltage [V]
8354
- - Vgbat: Ground battery voltage [V]
8364
+
8365
+ :returns: A pandas DataFrame containing the flight trajectory with columns such as:
8366
+
8367
+ - **Hp** - wAltitude [ft]
8368
+ - **TAS** - True Air Speed [kt]
8369
+ - **CAS** - Calibrated Air Speed [kt]
8370
+ - **GS** - Ground Speed [kt]
8371
+ - **M** - Mach number [-]
8372
+ - **ROCD** - Rate of Climb/Descent [ft/min]
8373
+ - **ESF** - Energy Share Factor [-]
8374
+ - **FUEL** - Fuel flow [kg/s]
8375
+ - **FUELCONSUMED** - Total fuel consumed [kg]
8376
+ - **THR** - Thrust force [N]
8377
+ - **DRAG** - Drag force [N]
8378
+ - **time** - Elapsed time [s]
8379
+ - **dist** - Distance flown [NM]
8380
+ - **slope** - Trajectory slope [deg]
8381
+ - **mass** - Aircraft mass [kg]
8382
+ - **config** - Aerodynamic configuration
8383
+ - **LAT** - Latitude [deg]
8384
+ - **LON** - Longitude [deg]
8385
+ - **HDGTrue** - True heading [deg]
8386
+ - **HDGMagnetic** - Magnetic heading [deg]
8387
+ - **BankAngle** - Bank angle [deg]
8388
+ - **ROT** - Rate of turn [deg/s]
8389
+ - **Comment** - Comments for each segment
8390
+
8391
+ - **For BADAH:**
8392
+ - **Preq** - Required power [W]
8393
+ - **Peng** - Generated power [W]
8394
+ - **Pav** - Available power [W]
8395
+
8396
+ - **For BADAE (electric aircraft):**
8397
+ - **Pmec** - Mechanical power [W]
8398
+ - **Pelc** - Electrical power [W]
8399
+ - **Pbat** - Power supplied by the battery [W]
8400
+ - **SOCr** - Rate of battery state of charge depletion [%/h]
8401
+ - **SOC** - Battery state of charge [%]
8402
+ - **Ibat** - Battery current [A]
8403
+ - **Vbat** - Battery voltage [V]
8404
+ - **Vgbat** - Ground battery voltage [V]
8355
8405
  :rtype: pandas.DataFrame
8356
8406
  """
8357
8407