RCAIDE-GUI 1.0.0__py3-none-any.whl

tabs/mission/widgets/mission_segment_widget.py

@@ -0,0 +1,358 @@
+# RCAIDE_GUI/tabs/mission/widgets/mission_segment_widget.py
+
+# Created: May 2023, M. Clarke
+# ------------------------------------------------------------------------------
+# Imports
+# ------------------------------------------------------------------------------
+from PyQt6.QtCore import QEvent, QObject, Qt
+from PyQt6.QtWidgets import (
+    QWidget, QVBoxLayout, QHBoxLayout, QComboBox, QLabel, QLineEdit,
+    QGroupBox, QRadioButton
+)
+
+from tabs.mission.widgets.flight_controls_widget import FlightControlsWidget
+from tabs.mission.widgets.mission_segment_helper import (
+    segment_data_fields,
+    segment_rcaide_classes,
+)
+from utilities import Units, set_data, convert_name
+import rcaide_io
+import RCAIDE
+from common_widgets import DataEntryWidget
+
+
+class _MissionComboWheelGuard(QObject):
+    def eventFilter(self, obj, event):
+        # Prevent hover-scrolling from changing combo values unless the user
+        # has explicitly opened the combo box popup.
+        if event.type() == QEvent.Type.Wheel and isinstance(obj, QComboBox):
+            if not obj.view().isVisible():
+                event.ignore()
+                return True
+        return super().eventFilter(obj, event)
+
+
+class MissionSegmentWidget(QWidget):
+    def __init__(self):
+        super().__init__()
+        self._combo_wheel_guard = _MissionComboWheelGuard(self)
+
+        # ============================================================
+        # Root Layout
+        # ============================================================
+        self.segment_layout = QVBoxLayout()
+        self.segment_layout.setAlignment(Qt.AlignmentFlag.AlignTop)
+        self.setLayout(self.segment_layout)
+
+        # Runtime widgets
+        self.subsegment_entry_widget = None
+        self.dof_entry_widget = None
+        self.flight_controls_widget = None
+        self._suppress_defaults = False
+
+        # Dropdowns
+        self.top_dropdown = QComboBox()
+        self.nested_dropdown = QComboBox()
+        self.config_selector = QComboBox()
+
+        # ============================================================
+        # Group 1 — Specify Segment Settings
+        # ============================================================
+        self.settings_group = QGroupBox("Segment Settings")
+        self.settings_group.setStyleSheet(self._box_style())
+        self.settings_layout = QVBoxLayout(self.settings_group) 
+        
+        cp_row = QHBoxLayout()
+        cp_row.addWidget(QLabel("Number of Control Points:"))
+        self.ctrl_points = QLineEdit("16")
+        self.ctrl_points.setFixedWidth(70)
+        self.ctrl_points.setAlignment(Qt.AlignmentFlag.AlignCenter)
+        cp_row.addWidget(self.ctrl_points)
+        cp_row.addStretch(1)
+        self.settings_layout.addLayout(cp_row)
+
+        solver_row = QHBoxLayout()
+        solver_row.addWidget(QLabel("Mission Solver:"))
+        self.solver_root = QRadioButton("Root Solver")
+        self.solver_opt = QRadioButton("Optimize Solver")
+        self.solver_root.setChecked(True)
+        solver_row.addWidget(self.solver_root)
+        solver_row.addWidget(self.solver_opt)
+        solver_row.addStretch(1)
+        self.settings_layout.addLayout(solver_row)
+
+        self.segment_layout.addWidget(self.settings_group)
+
+        # ============================================================
+        # Group 2 — Specify Segment Details
+        # ============================================================
+        self.details_group = QGroupBox("Mission Profile")
+        self.details_group.setStyleSheet(self._box_style())
+        self.details_layout = QVBoxLayout(self.details_group)
+
+        self.details_layout.addWidget(QLabel("Segment Name:"))
+        self.segment_name_input = QLineEdit()
+        self.details_layout.addWidget(self.segment_name_input)
+
+        self.details_layout.addWidget(QLabel("Segment Classification:"))
+        self.top_dropdown.addItems([
+            "Climb", "Cruise", "Descent", "Ground",
+            "Single_Point", "Vertical Flight"
+        ])
+        self.details_layout.addWidget(self.top_dropdown)
+
+        self.details_layout.addWidget(QLabel("Segment Type:"))
+        self.populate_nested_dropdown(0)
+        self.details_layout.addWidget(self.nested_dropdown)
+
+        self.details_layout.addWidget(QLabel("Vehicle Configuration:"))
+        cfg_container = getattr(rcaide_io, "rcaide_configs", None)
+        config_names  = list(cfg_container.keys()) if hasattr(cfg_container, 'keys') else []
+        self.details_layout.addWidget(QLabel("Segment Details:"))
+        self.config_selector.addItems([n for n in config_names if n])
+        self.details_layout.addWidget(self.config_selector)
+
+        self.segment_layout.addWidget(self.details_group)
+
+        # ============================================================
+        # Group 3 — Degrees of Freedom
+        # ============================================================
+        self.dof_group = QGroupBox("Select Degrees of Freedom")
+        self.dof_group.setStyleSheet(self._box_style())
+        dof_layout = QVBoxLayout(self.dof_group)
+
+        dof_fields = [
+            ("Forces in X axis", Units.Boolean, "flight_dynamics.force_x"),
+            ("Moments about X axis", Units.Boolean, "flight_dynamics.moment_x"),
+            ("Forces in Y axis", Units.Boolean, "flight_dynamics.force_y"),
+            ("Moments about Y axis", Units.Boolean, "flight_dynamics.moment_y"),
+            ("Forces in Z axis", Units.Boolean, "flight_dynamics.force_z"),
+            ("Moments about Z axis", Units.Boolean, "flight_dynamics.moment_z"),
+        ]
+
+        self.dof_entry_widget = DataEntryWidget(dof_fields)
+        dof_layout.addWidget(self.dof_entry_widget)
+        self.segment_layout.addWidget(self.dof_group)
+
+        # ============================================================
+        # Group 4 — Flight Controls
+        # ============================================================
+        self.fc_group = QGroupBox("Select Flight Controls")
+        self.fc_group.setStyleSheet(self._box_style())
+        fc_layout = QVBoxLayout(self.fc_group)
+
+        self.flight_controls_widget = FlightControlsWidget()
+        fc_layout.addWidget(self.flight_controls_widget)
+        self.segment_layout.addWidget(self.fc_group)
+
+        # ============================================================
+        # Signals
+        # ============================================================
+        self.top_dropdown.currentIndexChanged.connect(
+            self._on_top_dropdown_change
+        )
+        self.nested_dropdown.currentIndexChanged.connect(
+            self.update_subsegment_fields
+        )
+        self.segment_name_input.textChanged.connect(
+            self._on_segment_name_change
+        )
+
+        #self._apply_defaults()
+        self._install_combo_wheel_guards()
+
+    # ============================================================
+    # Styling
+    # ============================================================
+    def _box_style(self):
+        return """
+        QGroupBox {
+            color:#cfe0ff;
+            font-weight:600;
+            border:1px solid #2d3a4e;
+            border-radius:6px;
+            padding:20px;
+            margin-bottom:20px;
+        }
+        """
+
+    # ============================================================
+    # Dropdown Logic
+    # ============================================================
+    def populate_nested_dropdown(self, index):
+        # Clear old subsegment options
+        self.nested_dropdown.clear()
+
+        # Populate subsegments for the selected segment type
+        self.nested_dropdown.addItems(
+            list(segment_data_fields[index].keys())
+        )
+
+    def _on_top_dropdown_change(self, idx):
+        # Update available subsegments when segment type changes
+        self.populate_nested_dropdown(idx)
+
+        # Rebuild the subsegment-specific input fields
+        self.update_subsegment_fields()
+
+    # ============================================================
+    # Subsegment Handling
+    # ============================================================
+    def update_subsegment_fields(self):
+        # Remove the previous subsegment input widget if it exists
+        if self.subsegment_entry_widget:
+            self.subsegment_entry_widget.setParent(None)
+            self.subsegment_entry_widget = None
+
+        # Get the selected segment type and subsegment
+        top = self.top_dropdown.currentIndex()
+        sub = self.nested_dropdown.currentText()
+
+        # Do nothing if no subsegment is selected
+        if not sub:
+            return
+
+        # Create input fields for the selected subsegment
+        self.subsegment_entry_widget = DataEntryWidget(
+            segment_data_fields[top][sub]
+        )
+
+        # Add the subsegment fields to the UI
+        self.details_layout.addWidget(self.subsegment_entry_widget)
+        self._install_combo_wheel_guards(self.subsegment_entry_widget) 
+
+    def _apply_config_default(self, config_key):
+        cfg_container = getattr(rcaide_io, "rcaide_configs", None)
+        if not hasattr(cfg_container, 'keys') or not cfg_container:
+            return
+        for key in cfg_container.keys():
+            if convert_name(key) == config_key:
+                self.config_selector.setCurrentText(key)
+                break
+
+    def _on_segment_name_change(self, _):
+        # Avoid changing defaults while loading saved data
+        if self._suppress_defaults:
+            return
+
+        # Recompute the correct aircraft configuration
+        config_key = self._default_config_key(
+            self.top_dropdown.currentText(),
+            self.nested_dropdown.currentText(),
+            self.segment_name_input.text(),
+        )
+
+        # Apply the inferred configuration
+        self._apply_config_default(config_key)
+        
+    def _install_combo_wheel_guards(self, root=None):
+        root = root or self
+        # Apply the guard to existing mission-tab combo boxes, including any
+        # detail widgets rebuilt when the segment type changes.
+        for combo in root.findChildren(QComboBox):
+            combo.installEventFilter(self._combo_wheel_guard)
+
+    # ============================================================
+    # Save / Load
+    # ============================================================
+    def get_form_data(self):
+        # Save only the UI-entered mission fields; do not build RCAIDE objects here.
+        data = {
+            "Segment Name":   self.segment_name_input.text(),
+            "top dropdown":   self.top_dropdown.currentIndex(),
+            "nested dropdown": self.nested_dropdown.currentText(),
+            "config":         self.config_selector.currentText(),
+            "Control Points": int(self.ctrl_points.text()),
+            "Solver":         "root" if self.solver_root.isChecked() else "optimize",
+            "flight forces":  self.dof_entry_widget.get_values(),
+            "flight controls": self.flight_controls_widget.get_data(),
+        }
+        data.update(self.subsegment_entry_widget.get_values())
+        return data
+
+    def get_data(self):
+        # RCAIDE segment creation is kept separate so plain mission saves cannot fail on missing analyses.
+        data = self.get_form_data()
+        return data, self.create_rcaide_segment()
+
+    def load_data(self, data):
+        self._suppress_defaults = True
+
+        self.segment_name_input.setText(data["Segment Name"])
+        self.top_dropdown.setCurrentIndex(data["top dropdown"])
+        self.populate_nested_dropdown(data["top dropdown"])
+        self.nested_dropdown.setCurrentText(data["nested dropdown"])
+        config_val = data.get("config", "")
+        if isinstance(config_val, int):
+            self.config_selector.setCurrentIndex(config_val)
+        else:
+            self.config_selector.setCurrentText(str(config_val))
+        self.ctrl_points.setText(str(data.get("Control Points", 16)))
+
+        if data.get("Solver", "root") == "root":
+            self.solver_root.setChecked(True)
+        else:
+            self.solver_opt.setChecked(True)
+
+        self.update_subsegment_fields()
+        self.subsegment_entry_widget.load_data(data)
+        self.dof_entry_widget.load_data(data["flight forces"])
+        self.flight_controls_widget.load_data(data["flight controls"])
+
+        self._suppress_defaults = False
+
+    # ============================================================
+    # RCAIDE Segment Creation
+    # ============================================================
+    def create_rcaide_segment(self):
+        top = self.top_dropdown.currentIndex()
+        sub = self.nested_dropdown.currentText()
+
+        seg = segment_rcaide_classes[top][sub]()
+        seg.tag = self.segment_name_input.text()
+
+        if hasattr(seg, "state") and hasattr(seg.state, "numerics"):
+            solver = (
+                "root_finder"
+                if self.solver_root.isChecked()
+                else "optimize"
+            )
+            # Force cruise to use root_finder for better trim convergence
+            if top == 1:
+                solver = "root_finder"
+            if hasattr(seg.state.numerics, "solver"):
+                seg.state.numerics.solver.type = solver
+
+        vals_si = self.subsegment_entry_widget.get_values_si()
+        for label, _, rcaide_label in (
+            self.subsegment_entry_widget.data_units_labels
+        ):
+            set_data(seg, rcaide_label, vals_si[label][0])
+
+        dof_vals = self.dof_entry_widget.get_values()
+        for label, _, rcaide_label in (
+            self.dof_entry_widget.data_units_labels
+        ):
+            set_data(seg, rcaide_label, dof_vals[label][0])
+
+        cfg = convert_name(self.config_selector.currentText())
+        analyses = rcaide_io.rcaide_analyses.get(cfg)
+        if analyses is None or (hasattr(analyses, "__len__") and len(analyses) == 0):
+            fallback = None
+            for candidate in rcaide_io.rcaide_analyses.values():
+                if hasattr(candidate, "__len__") and len(candidate) > 0:
+                    fallback = candidate
+                    break
+            if fallback is not None:
+                analyses = fallback
+            else:
+                raise RuntimeError(
+                    "No RCAIDE analyses available. "
+                    "Go to Mission tab and press 'Save Analyses'."
+                )
+
+        seg.analyses.extend(analyses)
+        self.flight_controls_widget.set_control_variables(seg)
+        seg.control_points = int(self.ctrl_points.text())
+
+        return seg

tabs/solve/__init__.py

@@ -0,0 +1,4 @@
+# RCAIDE_GUI/tabs/solve/__init__.py
+
+from . import plots
+from .solve import * 

tabs/solve/plots/__init__.py

@@ -0,0 +1,12 @@
+# RCAIDE_GUI/tabs/solve/plots/__init__.py
+
+from .create_plot_widgets import create_plot_widgets
+from .aerodynamics        import *
+from .common              import *
+from .emissions           import *
+from .energy              import *
+from .mission             import *
+from .aeroacoustics       import *
+from .thermal_management  import *
+from .stability           import *
+from .weights             import *

tabs/solve/plots/aeroacoustics/__init__.py

@@ -0,0 +1,6 @@
+# RCAIDE_GUI/tabs/solve/plots/aeroacoustics/__init__.py
+
+from .plot_noise_level                 import plot_noise_level
+from .plot_3D_noise_contour            import plot_3D_noise_contour
+from .plot_2D_noise_contour            import plot_2D_noise_contour
+from .plot_noise_certification_contour import plot_noise_certification_contour

tabs/solve/plots/aeroacoustics/plot_2D_noise_contour.py

@@ -0,0 +1,184 @@
+# RCAIDE_GUI/tabs/solve/plots/aeroacoustics/plot_2D_noise_contour.py
+
+# RCAIDE imports
+from RCAIDE.Framework.Core import Units
+
+# Python imports
+import numpy as np
+import matplotlib.pyplot as plt
+import matplotlib.colors
+import matplotlib.colors as colors
+
+# ------------------------------------------------------------------------------
+# Plot 2D Noise Contour
+# ------------------------------------------------------------------------------
+def plot_2D_noise_contour(noise_data,
+                       noise_level = None,
+                       min_noise_level = 35,  
+                       max_noise_level = 90, 
+                       noise_scale_label = None,
+                       save_figure = False,
+                       show_figure = True,
+                       save_filename = "2D_Noise_Contour",
+                       show_elevation = False,
+                       use_lat_long_coordinates = False,  
+                       colormap = 'jet',
+                       file_type = ".png",
+                       width = 10, 
+                       height = 7):
+    """
+    Creates a 2D contour plot of noise levels with optional terrain elevation.
+
+    Parameters
+    ----------
+    noise_data : NoiseData
+        RCAIDE noise data structure containing:
+            - microphone_locations[:,:,0:3]
+                3D array of microphone positions
+            - microphone_coordinates[:,:,0:2]
+                Latitude and longitude of measurement points
+            - topography_file
+                Optional path to terrain elevation data
+            
+    noise_level : ndarray, optional
+        2D array of noise levels at measurement points
+        
+    min_noise_level : float, optional
+        Minimum noise level for contour scale (default: 35 dB)
+        
+    max_noise_level : float, optional
+        Maximum noise level for contour scale (default: 90 dB)
+        
+    noise_scale_label : str, optional
+        Label for noise metric (e.g., "dBA", "EPNL", etc.)
+        
+    save_figure : bool, optional
+        Flag for saving the figure (default: False)
+        
+    show_figure : bool, optional
+        Flag to display the figure (default: True)
+        
+    save_filename : str, optional
+        Name of file for saved figure (default: "2D_Noise_Contour")
+        
+    show_elevation : bool, optional
+        Flag to display terrain elevation contours (default: False)
+        
+    use_lat_long_coordinates : bool, optional
+        Flag to use geographic coordinates (default: True)
+        
+    colormap : str, optional
+        Colormap specification for noise contours (default: 'jet')
+        
+    file_type : str, optional
+        File extension for saved figure (default: ".png")
+        
+    width : float, optional
+        Figure width in inches (default: 10)
+        
+    height : float, optional
+        Figure height in inches (default: 7)
+
+    Returns
+    -------
+    fig : plotly.graph_objects.Figure
+        Handle to the generated figure
+
+    Notes
+    -----
+    Creates visualization showing:
+        - Noise level contours
+        - Optional terrain elevation
+        - Geographic or Cartesian coordinates
+        - Customizable color scales
+    
+    **Definitions**
+    
+    'Noise Level'
+        Sound pressure level or derived metric
+    'Terrain Elevation'
+        Height above sea level
+    'Geographic Coordinates'
+        Latitude and longitude positions
+    
+    See Also
+    --------
+    RCAIDE.Library.Plots.Noise.plot_3D_noise_contour : 3D visualization of noise field
+    RCAIDE.Library.Plots.Noise.post_process_noise_data : Data preparation for plotting
+    """      
+    
+    elevation       = noise_data.microphone_locations[:,:,2]/Units.ft      
+    colors_undersea = plt.cm.terrain(np.linspace(0, 0.17, 56))
+    colors_land     = plt.cm.terrain(np.linspace(0.25, 1, 200))  
+    colors          = np.vstack((colors_undersea, colors_land))
+    cut_terrain_map = matplotlib.colors.LinearSegmentedColormap.from_list('cut_terrain', colors) 
+    norm = FixPointNormalize(sealevel=0,vmax=np.max(elevation),vmin=np.min(elevation))  
+     
+    fig = plt.figure(save_filename)
+    fig.set_size_inches(width,height)
+    
+    axis = fig.add_subplot(1,1,1) 
+    
+    noise_levels   = np.linspace(min_noise_level,max_noise_level,10)  
+    noise_cmap     = plt.get_cmap('turbo')
+    noise_new_cmap = truncate_colormap(noise_cmap,0.0, 1.0) 
+     
+    if use_lat_long_coordinates:
+        LAT  = noise_data.microphone_coordinates[:,:,0]
+        LONG = noise_data.microphone_coordinates[:,:,1]
+        axis.set_xlabel('Longitude [°]')
+        axis.set_ylabel('Latitude [°]') 
+    else:
+        LAT  = noise_data.microphone_locations[:,:,0]
+        LONG = noise_data.microphone_locations[:,:,1]
+        axis.set_xlabel('x [m]')
+        axis.set_ylabel('y [m]')  
+    
+    if show_elevation:
+        CS_1  = axis.contourf(LONG,LAT,elevation,cmap =cut_terrain_map,norm=norm,levels = 20, alpha=0.5)  
+        cbar = fig.colorbar(CS_1, ax=axis)     
+        cbar.ax.set_ylabel('Elevation above sea level [ft]', rotation =  90)  
+
+    # plot aircraft noise levels   
+    CS_2    = axis.contourf(LONG,LAT,noise_level ,noise_levels,cmap = noise_new_cmap)     
+    cbar    = fig.colorbar(CS_2, ax=axis)        
+    cbar.ax.set_ylabel(noise_scale_label, rotation =  90) 
+        
+    fig.tight_layout()  
+    if save_figure: 
+        figure_title  = save_filename
+        plt.savefig(figure_title + file_type )     
+         
+    return fig       
+
+# ------------------------------------------------------------------ 
+# Truncate colormaps
+# ------------------------------------------------------------------  
+def truncate_colormap(cmap, minval=0.0, maxval=1.0, n=100):
+    new_cmap = colors.LinearSegmentedColormap.from_list(
+        'trunc({n},{a:.2f},{b:.2f})'.format(n=cmap.name, a=minval, b=maxval),
+        cmap(np.linspace(minval, maxval, n)))
+    return new_cmap
+
+
+class FixPointNormalize(matplotlib.colors.Normalize):
+    """ 
+    Inspired by https://stackoverflow.com/questions/20144529/shifted-colorbar-matplotlib
+    Subclassing Normalize to obtain a colormap with a fixpoint 
+    somewhere in the middle of the colormap.
+    This may be useful for a `terrain` map, to set the "sea level" 
+    to a color in the blue/turquise range. 
+    """
+    def __init__(self, vmin=None, vmax=None, sealevel=0, col_val = 0.21875, clip=False):
+        # sealevel is the fix point of the colormap (in data units)
+        self.sealevel = sealevel
+        # col_val is the color value in the range [0,1] that should represent the sealevel.
+        self.col_val = col_val
+        matplotlib.colors.Normalize.__init__(self, vmin, vmax, clip)
+
+    def __call__(self, value, clip=None):
+        x, y = [self.vmin, self.sealevel, self.vmax], [0, self.col_val, 1]
+        return np.ma.masked_array(np.interp(value, x, y))   
+
+def colorax(vmin, vmax):
+    return dict(cmin=vmin,cmax=vmax)