Clean up the aircraft specs files and add readme

Author: A-CGray

AircraftSpecs/FlightPoint.py

@@ -14,8 +14,8 @@ def __init__(self, name: str, loadFactor: float, fuelFraction: float, failureGro
             Flight point load factor (how many G's the aircraft is pulling)
         fuelFraction : float
             What fraction of the total fuel mass is the aircraft carrying at this flight point
-        failureGroups : _type_
-            _description_
+        failureGroups : list of strings
+            Names of wingbox component groups for which to compute a failure constraint value at this flight point
         """
         super().__init__(name=name, **kwargs)
 

AircraftSpecs/Boeing717FlightPoints.py AircraftSpecs/MACHTutorialWingFlightPoints.py

@@ -1,8 +1,8 @@
 """
 ==============================================================================
-Definition of Boeing 717 flight points
+Definition of MACH Tutorial wing flight points
 ==============================================================================
-@File    :   Boeing717FlightPoints.py
+@File    :   MACHTutorialWingFlightPoints.py
 @Date    :   2023/10/05
 @Author  :   Alasdair Christison Gray
 @Description :

AircraftSpecs/Boeing717Specs.py AircraftSpecs/MACHTutorialWingSpecs.py

@@ -1,11 +1,30 @@
+"""
+==============================================================================
+MACH Tutorial wing aircraft and mission specifications
+==============================================================================
+@File    :   MACHTutorialWingSpecs.py
+@Date    :   2023/10/05
+@Author  :   Alasdair Christison Gray
+@Description :
+"""
+
+# ==============================================================================
+# Standard Python modules
+# ==============================================================================
 import sys
 import os
-import numpy as np
 
+# ==============================================================================
+# External Python modules
+# ==============================================================================
+import numpy as np
 import openmdao.api as om
 from openconcept.aerodynamics import ParasiteDragCoefficient_JetTransport
 
-from Boeing717FlightPoints import standardCruise
+# ==============================================================================
+# Extension modules
+# ==============================================================================
+from MACHTutorialWingFlightPoints import standardCruise
 
 sys.path.append(os.path.join(os.path.dirname(os.path.abspath(__file__)), "../geometry"))
 from wingGeometry import wingGeometry  # noqa: E402
@@ -47,7 +66,7 @@
 MAX_WING_LOADING = 650.0  # kg/m^2 Max allowable wing loading
 
 # ==============================================================================
-# Drag estimate
+# Airframe drag estimate
 # ==============================================================================
 fuselageLaminarFrac = 0.05  # Raymer table 12.4
 tailLaminarFrac = 0.1  # Raymer table 12.4

AircraftSpecs/README.md

@@ -0,0 +1,6 @@
+# Structural files
+
+## File descriptions:
+
+- **`MACHTutorialWingSpecs.py`:** Python file containing various aircraft and mission specifications, designed to be imported and used in other scripts, particularly the `aircraftSpecs` dictionary.
+- **`MACHTutorialWingFlightPoints.py`:** Python file defining the flight point objects for each of the flight points used in the MACH Tutorial Wing benchmark problems.