RCAIDE-GUI 1.0.2__tar.gz → 1.0.3__tar.gz

{rcaide_gui-1.0.2 → rcaide_gui-1.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RCAIDE-GUI
-Version: 1.0.2
+Version: 1.0.3
 Summary: RCAIDE Graphical User Interface: interactive desktop application for aircraft design and analysis
 License: MIT License
 Classifier: Development Status :: 4 - Beta

{rcaide_gui-1.0.2 → rcaide_gui-1.0.3}/RCAIDE_GUI.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RCAIDE-GUI
-Version: 1.0.2
+Version: 1.0.3
 Summary: RCAIDE Graphical User Interface: interactive desktop application for aircraft design and analysis
 License: MIT License
 Classifier: Development Status :: 4 - Beta

rcaide_gui-1.0.3/README.md

@@ -0,0 +1,171 @@
+<p align="center">
+  <img src="app_data/images/logo.png" alt="RCAIDE GUI logo" width="140">
+</p>
+
+<h1 align="center">RCAIDE GUI</h1>
+
+<p align="center">
+  <strong>A visual aircraft design, analysis, and mission simulation workspace powered by RCAIDE.</strong>
+</p>
+
+<p align="center">
+  <a href="https://pepy.tech/projects/rcaide-gui">
+    <img src="https://static.pepy.tech/badge/rcaide-gui" alt="PyPI Downloads">
+  </a>
+  <a href="https://pypi.org/project/RCAIDE-GUI/">
+    <img src="https://img.shields.io/pypi/v/RCAIDE-GUI?label=PyPI" alt="PyPI Version">
+  </a>
+  <a href="LICENSE">
+    <img src="https://img.shields.io/badge/license-MIT-0B7285" alt="License">
+  </a>
+  <a href="https://github.com/leadsgroup/RCAIDE_GUI/stargazers">
+  <img src="https://img.shields.io/github/stars/leadsgroup/RCAIDE_GUI?style=social" alt="GitHub Stars">
+</a>
+</p>
+
+<p align="center">
+  <a href="https://www.rcaide.leadsresearchgroup.com/gui/">Website</a>
+  |
+  <a href="https://www.docs.rcaide.leadsresearchgroup.com/install.html">Documentation</a>
+</p>
+
+<p align="center">
+  <img src="app_data/images/Home%20(3).png" alt="RCAIDE GUI home screen" width="92%">
+</p>
+
+## What is RCAIDE GUI?
+
+ To make user interaction with [RCAIDE](https://pypi.org/project/RCAIDE-LEADS/) easier and more intuitive, the RCAIDE Graphical User Interface (GUI) was developed. Implemented as a Python desktop application, the GUI provides a structured and visual workflow that guides users through the aircraft design process in a more organized and simplified way. Rather than working with scattered inputs and manual scripting, users can define the vehicle, configure analyses, and construct missions within a single environment. 
+ 
+ The interface is arranged to follow the typical aircraft design workflow, making it easier for users to navigate the design process while reducing the likelihood of technical setup mistakes. By keeping all stages of development within one system, users can focus more on aircraft design decisions rather than software configuration and implementation details.
+
+ Developed and maintained by the [Lab for Electric Aircraft Design and Sustainability](https://www.leadsresearchgroup.com/).
+
+## Quick Start
+
+Install from PyPI:
+
+```bash
+pip install RCAIDE-GUI
+```
+
+Launch the desktop app:
+
+```bash
+rcaide-gui
+```
+
+Or run from source:
+
+```bash
+python main.py
+```
+
+## Design Workflow
+
+```mermaid
+%%{init: {'theme': 'base', 'themeVariables': {'primaryColor': '#FFFFFF', 'primaryBorderColor': '#0891B2', 'primaryTextColor': '#111827', 'lineColor': '#0891B2', 'fontFamily': 'Inter, ui-sans-serif, system-ui, sans-serif'}, 'flowchart': {'curve': 'linear', 'nodeSpacing': 48, 'rankSpacing': 56}}}%%
+flowchart LR
+    VS["Vehicle Setup"]
+    GV["Geometry Visualization"]
+    CS["Configurations"]
+    AS["Analyses"]
+    MS["Mission Setup"]
+    SIM["Mission Simulation"]
+
+    VS --> GV
+    GV --> CS
+    CS --> AS
+    AS --> MS
+    MS --> SIM
+
+    classDef workflow fill:#FFFFFF,stroke:#0891B2,stroke-width:2px,color:#111827;
+    class VS,GV,CS,AS,MS,SIM workflow;
+    linkStyle default stroke:#0891B2,stroke-width:2px;
+```
+
+## Application Tour
+
+<table>
+  <tr>
+    <td width="50%">
+      <h3>Vehicle Setup</h3>
+      <p>The Vehicle Setup tab serves as the foundation of the aircraft design process. Users can create and modify aircraft geometry through a component-based workflow, adding wings, fuselages, landing gear, propulsors, booms, and other vehicle components. A live aircraft preview allows users to verify geometry and placement in real time, while the vehicle details panel provides access to all design parameters and properties.
+</p>
+    </td>
+    <td width="50%">
+      <img src="app_data/images/Vehicle%20Setup%20(1).png" alt="Vehicle Setup tab">
+    </td>
+  </tr>
+  <tr>
+    <td width="50%">
+      <img src="app_data/images/Geometry_Visualization%20(1).png" alt="Geometry Visualization tab">
+    </td>
+    <td width="50%">
+      <h3>Geometry Visualization</h3>
+      <p>The Geometry Visualization tab provides a dedicated 3D environment for inspecting aircraft geometry. Powered by VTK, the viewer supports interactive rotation, zooming, measurement tools, customizable colors and transparency, predefined viewing angles, and image export capabilities. This environment allows users to verify component placement and evaluate aircraft geometry before running analyses.</p>
+    </td>
+  </tr>
+  <tr>
+    <td width="50%">
+      <h3>Configurations Setup</h3>
+      <p>The Configurations Setup tab allows users to define aircraft operating states for different phases of flight, including takeoff, cruise, landing, and custom mission conditions. Users can configure control surface deflections, landing gear deployment, and active propulsion systems while maintaining a clear connection to the baseline vehicle geometry. These configurations are later used throughout the mission and analysis workflow.</p>
+    </td>
+    <td width="50%">
+      <img src="app_data/images/Configurations%20(1).png" alt="Configurations Setup tab">
+    </td>
+  </tr>
+  <tr>
+    <td width="50%">
+      <img src="app_data/images/Mission%20Analysis%20(1).png" alt="Analyses Setup tab">
+    </td>
+    <td width="50%">
+      <h3>Analyses Setup</h3>
+      <p>The Analyses Setup tab provides access to RCAIDE's multidisciplinary analysis capabilities through a graphical interface. Users can configure aerodynamic methods, atmospheric models, weight estimation approaches, and aeroacoustic settings without directly interacting with Python code. The available options mirror those found within RCAIDE's analysis framework, ensuring consistency between GUI-based and script-based workflows.</p>
+    </td>
+  </tr>
+  <tr>
+    <td width="50%">
+      <h3>Mission Setup</h3>
+      <p>The Mission Setup tab enables users to create complete flight profiles through an intuitive visual workflow. Mission segments such as takeoff, climb, cruise, descent, and landing can be added and customized with specific operating conditions, solver settings, and control points. Each segment can also be linked to previously defined vehicle configurations and analyses, creating a fully integrated mission definition process.</p>
+    </td>
+    <td width="50%">
+      <img src="app_data/images/Mission%20Setup%20(1).png" alt="Mission Setup tab">
+    </td>
+  </tr>
+  <tr>
+    <td width="50%">
+      <img src="app_data/images/Mission%20Simulation%20(1).png" alt="Mission Simulation tab">
+    </td>
+    <td width="50%">
+      <h3>Mission Simulation</h3>
+      <p>The Mission Simulation tab is where aircraft designs are evaluated using RCAIDE's analysis framework. Once the vehicle, configurations, analyses, and mission profile have been defined, simulations can be executed directly from the GUI. Results are presented through plots and numerical outputs, including performance metrics, fuel burn, range, energy consumption, flight time, and stability characteristics, which can be exported for further analysis.</p>
+    </td>
+  </tr>
+</table>
+
+## Why Use It?
+
+| Capability | What it unlocks |
+| --- | --- |
+| Visual aircraft setup | Create and modify complex aircraft models without hand-writing setup scripts. |
+| Live geometry feedback | Catch sizing, placement, and configuration issues early in the design process. |
+| Connected analysis workflow | Move from geometry to configurations, analyses, missions, and results in one desktop environment. |
+| RCAIDE integration | Use the same open-source design and analysis ecosystem behind scripted RCAIDE workflows. |
+
+## Requirements
+
+- Python 3.9 or newer
+- PyQt6
+- pyvista and pyvistaqt
+- RCAIDE-LEADS, installed automatically with `RCAIDE-GUI`
+
+For platform-specific setup notes, see the [RCAIDE installation guide](https://www.docs.rcaide.leadsresearchgroup.com/install.html).
+
+## Contributing
+
+Contributions are welcome! If you want to add methods, improve documentation, or fix issues, start with the [RCAIDE contribution guidelines](https://www.docs.rcaide.leadsresearchgroup.com/contributing.html), then open a pull request against this repository.
+
+## Get in Touch
+
+Share feedback, report issues, and request features through [GitHub Issues](https://github.com/leadsgroup/RCAIDE_GUI/issues). For broader discussion with users and maintainers, join [GitHub Discussions](https://github.com/leadsgroup/RCAIDE_LEADS/discussions).

rcaide_gui-1.0.3/VERSION

@@ -0,0 +1 @@
+1.0.3

{rcaide_gui-1.0.2 → rcaide_gui-1.0.3}/rcaide_io.py

@@ -5,7 +5,7 @@ import importlib
 import numpy as np
 import types as _types_module
 from collections import OrderedDict
-from RCAIDE.load import read_RCAIDE_json_dict
+from RCAIDE.Input_Output.load import read_RCAIDE_json_dict
 from RCAIDE.Framework.Core import Data, DataOrdered
 
 _ROOT         = os.path.dirname(os.path.abspath(__file__))
@@ -353,7 +353,7 @@ def _build_dict_r_with_types(v):
 
 
 def _build_dict_base_with_types(base):
-    """Top-level serialisation: like RCAIDE.save.build_dict_base but includes __type__."""
+    """Top-level serialisation: like RCAIDE.Input_Output.save.build_dict_base but includes __type__."""
     _skip = ('_component_root_map', '_energy_network_root_map', '_base', '_diff')
     base_dict = {}
     for k in base.keys():
@@ -420,7 +420,7 @@ rcaide_mission  = RCAIDE.Framework.Mission.Sequential_Segments()
 
 def vehicle_to_ui_format(vehicle_obj):
     """Convert a RCAIDE vehicle object to UI format for display in frames."""
-    from RCAIDE.save import build_dict_base
+    from RCAIDE.Input_Output.save import build_dict_base
     from tabs.geometry.frames import VehicleFrame
 
     vehicle_dict = make_json_safe(build_dict_base(vehicle_obj))
@@ -770,7 +770,7 @@ def write_to_json():
 def read_from_json(data_str, source_dir=None):
     global rcaide_vehicle, vehicle, rcaide_configs, config_data, analysis_data, mission_data, propulsor_names, rcaide_analyses
     from RCAIDE.Library.Components.Configs.Config import Config
-    from RCAIDE.import_rcaide_data import analyses_setup as _analyses_setup
+    from RCAIDE.Input_Output.import_data import analyses_setup as _analyses_setup
 
     data = json.loads(data_str, object_pairs_hook=OrderedDict)
     rcaide_vehicle_dict  = data["rcaide_vehicle"]

rcaide_gui-1.0.2/README.md

@@ -1,62 +0,0 @@
-  <p align="center">
-    <img src="https://github.com/leadsgroup/RCAIDE_Website/blob/main/assets/img/RCAIDE_Logo_No_Background.png" width=25% height=25%> 
-  </p> 
-
-  # 
-  <div align="center">
-
-  <!-- [![CI](https://github.com/leadsgroup/RCAIDE_LEADS/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/leadsgroup/RCAIDE_LEADS/actions/workflows/CI.yml)
-  [![Documentation](https://github.com/leadsgroup/RCAIDE_LEADS/actions/workflows/sphinx_docs.yml/badge.svg)](https://github.com/leadsgroup/RCAIDE_LEADS/actions/workflows/sphinx_docs.yml)
-  [![codecov](https://codecov.io/gh/leadsgroup/RCAIDE_LEADS/graph/badge.svg?token=WZOFW5EKWJ)](https://codecov.io/gh/leadsgroup/RCAIDE_LEADS) -->
-
-  [![PyPI Downloads](https://static.pepy.tech/badge/rcaide-gui)](https://pepy.tech/projects/rcaide-gui)
-
-
-
-  </div>
-
-  [RCAIDE: Graphical User Interface]([link](https://www.rcaide.leadsresearchgroup.com/gui/))
-  =======
-  The Research Community Aircraft Interdisciplinary Design Environment (RCAIDE) Graphical User Interface (GUI) is an interactive, visual workflow for RCAIDE, a powerful open-source Python platform that revolutionizes aircraft design and analysis at a high-fidelity. The GUI provides an intuitive desktop application that allows aerospace engineers, researchers, and students to accelerate aircraft development and explore innovative designs without the need to write complex Python scripts. The software is developed and maintained by the [Lab for Electric Aircraft Design and Sustainability](https://www.leadsresearchgroup.com/)
-
-  [Find more information on RCAIDE, its capabilities, external interfaces, and how to download here.](https://www.docs.rcaide.leadsresearchgroup.com/install.html)
-  
-  ## RCAIDE GUI Architecture 
-   The RCAIDE GUI is structured into tabs to flow with the aircraft design process.
-
-  * **Vehicle Setup**: This is the foundation of designing your aircraft - defining your aircraft's geometry. Using a component tree, add wings, fuselages, nacelles, landing gear, booms, and propulsors. Then, specify parameters and dimensions to build up your aircraft. This tab also features a live 3D preview of the aircraft to instantly verify geometric dimensions and placements.
-  * **Geometry Visualization**: A complete 3D rendering environment powered by VTK. Using this tab, users can inspect their aircraft, check component placement, and export top, front, and side view visualization images before conducting further analysis.
-  * **Configurations Setup**: Define the physical states of the aircraft during different phases of flight. Users can set up base, takeoff, cruise, and landing configurations by specifying control surface deflections, landing gear deployment states, and active propulsors.
-  * **Analyses Setup**: Define the analysis for RCAIDE's multidisciplinary solvers. Users can toggle and select their analyses requirements and configure the fidelity of the physics models, including aerodynamic solvers, atmospheric conditions, weights, and aeroacoustic parameters.
-  * **Mission Setup**: Construct the flight profile. Users can chain together flight segments (takeoff, climb, cruise, descent). Each segment is customized with specific altitudes and speeds, and is linked to previously defined aircraft configurations and analyses.
-  * **Mission Simulation**: The tab that displays your results. Once the vehicle, analyses, and mission are defined, the tab runs the backend RCAIDE solvers and returns numerical and graphical outputs (such as performance data, payload-range charts, and stability metrics) for the user to evaluate and export.
-
-  ```mermaid
-  %%{init: {'flowchart': {'curve': 'linear', 'nodeSpacing': 50, 'rankSpacing': 50}}}%%
-  flowchart LR
-      VS[Vehicle Setup]
-      GV[Geometry Visualization]
-      CS[Configurations Setup]
-      AS[Analyses Setup]
-      MSP[Mission Setup]
-      MSI[Mission Simulation]
-      
-      
-      VS ---> GV
-      GV ---> CS
-      CS ---> AS
-      AS ---> MSP
-      MSP ---> MSI
-  ```
-
-  **Getting Involved**   
-
-  If you'd like to help us develop RCAIDE by adding new methods, writing documentation, or fixing embarrassing bugs, please look at these [guidelines](https://www.docs.rcaide.leadsresearchgroup.com/contributing.html).
-
-  Submit improvements or new features with a [pull request](https://github.com/leadsgroup/RCAIDE_LEADS/pulls)
-
-  ## Get in touch
-
-  Share feedback, report issues, and request features via or [Github Issues](https://github.com/leadsgroup/RCAIDE_LEADS/issues)
-
-  Engage with peers and maintainers in [Discussions](https://github.com/leadsgroup/RCAIDE_LEADS/discussions)

rcaide_gui-1.0.2/VERSION

@@ -1 +0,0 @@
-1.0.2