Aeroframe with new framAT version, compatible with python 3.11 (#316)

New framat version and related libraries updated, added aeroframe_new with integration test

Author: LeonDeligny

CEASIOMpy_docker_Installation

@@ -100,7 +100,7 @@ RUN /bin/bash -c "source $CONDA_DIR/etc/profile.d/conda.sh && conda activate cea
 # Automatically activate the Conda environment in new shells
 RUN echo "source $CONDA_DIR/etc/profile.d/conda.sh" >> ~/.bashrc && \
     echo "conda activate ceasiompy" >> ~/.bashrc && \
-    echo "ceasiompy_run --gui" >> ~/.bashrc
+    echo "python src/bin/ceasiompy_run --gui" >> ~/.bashrc
 
 # Move the content of /INSTALLDIR to the mounted /CEASIOMpy/INSTALLDIR folder at runtime
 CMD ["/bin/bash", "-c", "rm -rf /CEASIOMpy/INSTALLDIR && mkdir -p /CEASIOMpy/INSTALLDIR && mv /INSTALLDIR/* /CEASIOMpy/INSTALLDIR/ && exec bash"]

README.md

@@ -173,7 +173,7 @@ There are many different modules available in CEASIOMpy that can be combined to
 
 #### Structure
 
-- [AeroFrame](./ceasiompy/AeroFrame_new/README.md) :heavy_check_mark:
+- [AeroFrame](./ceasiompy/AeroFrame/README.md) :heavy_check_mark:
 
 #### Data Analysis and Storage
 

ceasiompy/AeroFrame_new/README.md renamed to ceasiompy/AeroFrame/README.md

@@ -4,10 +4,6 @@
 Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
 
 Initialization for AeroFrame new module.
-
-| Author: Leon Deligny
-| Creation: 18-Mar-2025
-
 """
 
 # ==============================================================================
@@ -16,7 +12,7 @@
 
 from pathlib import Path
 
-from ceasiompy import log
+from ceasiompy.utils.commonxpaths import CEASIOMPY_XPATH
 
 # ==============================================================================
 #   INITIALIZATION
@@ -35,10 +31,15 @@
 MODULE_DIR = Path(__file__).parent
 MODULE_NAME = MODULE_DIR.name
 
+# ===== xPaths =====
 
-# =================================================================================================
-#    MAIN
-# =================================================================================================
+# FramAT
+FRAMAT_XPATH = CEASIOMPY_XPATH + "/structure/FramAT"
+FRAMAT_MATERIAL_XPATH = FRAMAT_XPATH + "/MaterialProperties"
+FRAMAT_SECTION_XPATH = FRAMAT_XPATH + "/SectionProperties"
+FRAMAT_MESH_XPATH = FRAMAT_XPATH + "/BeamMesh"
+FRAMAT_RESULTS_XPATH = FRAMAT_XPATH + "/Results"
 
-if __name__ == "__main__":
-    log.info("Nothing to be executed.")
+# AeroFrame
+AEROFRAME_XPATH = CEASIOMPY_XPATH + "/aeroelasticity/AeroFrame"
+AEROFRAME_SETTINGS = AEROFRAME_XPATH + "/Settings"

ceasiompy/AeroFrame_new/__init__.py renamed to ceasiompy/AeroFrame/__init__.py

@@ -1,34 +1,43 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+GUI Interface of Aeroframe.
+"""
+
+# ==============================================================================
+#   IMPORTS
+# ==============================================================================
+
+import streamlit as st
+
 from ceasiompy.utils.moduleinterfaces import CPACSInOut
 
-from ceasiompy import log
 from ceasiompy.PyAVL import (
     AVL_PLOT_XPATH,
-    AVL_VORTEX_DISTR_XPATH,
+    AVL_DISTR_XPATH,
     AVL_AEROMAP_UID_XPATH,
+    AVL_NCHORDWISE_XPATH,
+    AVL_NSPANWISE_XPATH,
 )
-from ceasiompy.utils.commonxpaths import (
-    CEASIOMPY_XPATH,
-    AEROPERFORMANCE_XPATH,
+from ceasiompy.AeroFrame import (
+    INCLUDE_GUI,
     FRAMAT_MATERIAL_XPATH,
     FRAMAT_SECTION_XPATH,
     FRAMAT_MESH_XPATH,
-    AEROFRAME_SETTINGS
+    AEROFRAME_SETTINGS,
 )
-from pathlib import Path
-
-import streamlit as st
-# ===== Module Status =====
-# True if the module is active
-# False if the module is disabled (not working or not ready)
-MODULE_STATUS = True
 
-RESULTS_DIR = Path("Results", "AeroFrame_new")
-
-# ===== CPACS inputs and outputs =====
+# ==============================================================================
+#   VARIABLE
+# ==============================================================================
 
 cpacs_inout = CPACSInOut()
 
-# ----- Input -----
+# ==============================================================================
+#   CALL
+# ==============================================================================
 
 cpacs_inout.add_input(
     var_name="aeromap_uid",
@@ -37,7 +46,7 @@
     unit=None,
     descr="Name of the aero map to calculate",
     xpath=AVL_AEROMAP_UID_XPATH,
-    gui=True,
+    gui=INCLUDE_GUI,
     gui_name="__AEROMAP_SELECTION",
     gui_group="Aeromap settings",
 )
@@ -48,8 +57,8 @@
     default_value=["equal", "cosine", "sine"],
     unit=None,
     descr=("Select the type of distribution"),
-    xpath=AVL_VORTEX_DISTR_XPATH + "/Distribution",
-    gui=True,
+    xpath=AVL_DISTR_XPATH,
+    gui=INCLUDE_GUI,
     gui_name="Choice of distribution",
     gui_group="AVL: Vortex Lattice Spacing Distributions",
 )
@@ -60,8 +69,8 @@
     default_value=8,
     unit=None,
     descr="Select the number of chordwise vortices",
-    xpath=AVL_VORTEX_DISTR_XPATH + "/Nchordwise",
-    gui=True,
+    xpath=AVL_NCHORDWISE_XPATH,
+    gui=INCLUDE_GUI,
     gui_name="Number of chordwise vortices",
     gui_group="AVL: Vortex Lattice Spacing Distributions",
 )
@@ -72,8 +81,8 @@
     default_value=30,
     unit=None,
     descr="Select the number of spanwise vortices",
-    xpath=AVL_VORTEX_DISTR_XPATH + "/Nspanwise",
-    gui=True,
+    xpath=AVL_NSPANWISE_XPATH,
+    gui=INCLUDE_GUI,
     gui_name="Number of spanwise vortices",
     gui_group="AVL: Vortex Lattice Spacing Distributions",
 )
@@ -85,9 +94,11 @@
     unit=None,
     descr="Select to save geometry and results plots",
     xpath=AVL_PLOT_XPATH,
-    gui=True,
+    gui=INCLUDE_GUI,
     gui_name="Save AVL plots",
     gui_group="Plots",
+    test_value=False,
+    expanded=False,
 )
 
 cpacs_inout.add_input(
@@ -97,7 +108,7 @@
     unit=None,
     descr="Enter number of nodes for the beam mesh.",
     xpath=FRAMAT_MESH_XPATH + "/NumberNodes",
-    gui=True,
+    gui=INCLUDE_GUI,
     gui_name="Number of beam nodes",
     gui_group="FramAT: Mesh properties",
 )
@@ -109,7 +120,7 @@
     unit=None,
     descr="Enter the Young modulus of the wing material in GPa.",
     xpath=FRAMAT_MATERIAL_XPATH + "/YoungModulus",
-    gui=True,
+    gui=INCLUDE_GUI,
     gui_name="Young modulus [GPa]",
     gui_group="FramAT: Material properties",
 )
@@ -121,7 +132,7 @@
     unit=None,
     descr="Enter the shear modulus of the wing material in GPa.",
     xpath=FRAMAT_MATERIAL_XPATH + "/ShearModulus",
-    gui=True,
+    gui=INCLUDE_GUI,
     gui_name="Shear modulus [GPa]",
     gui_group="FramAT: Material properties",
 )
@@ -133,7 +144,7 @@
     unit=None,
     descr="Enter the density of the wing material in kg/m³.",
     xpath=FRAMAT_MATERIAL_XPATH + "/Density",
-    gui=True,
+    gui=INCLUDE_GUI,
     gui_name="Material density [kg/m³]",
     gui_group="FramAT: Material properties",
 )
@@ -145,7 +156,7 @@
     unit=None,
     descr="Enter the area of the cross-section in m².",
     xpath=FRAMAT_SECTION_XPATH + "/Area",
-    gui=True,
+    gui=INCLUDE_GUI,
     gui_name="Cross-section area [m²]",
     gui_group="FramAT: Cross-section properties",
 )
@@ -158,7 +169,7 @@
     descr="Enter the second moment of area of the cross-section \
             about the horizontal axis, in m⁴.",
     xpath=FRAMAT_SECTION_XPATH + "/Ix",
-    gui=True,
+    gui=INCLUDE_GUI,
     gui_name="Second moment of area Ix [m⁴]",
     gui_group="FramAT: Cross-section properties",
 )
@@ -171,7 +182,7 @@
     descr="Enter the second moment of area of the cross-section \
             about the vertical axis, in m⁴",
     xpath=FRAMAT_SECTION_XPATH + "/Iy",
-    gui=True,
+    gui=INCLUDE_GUI,
     gui_name="Second moment of area Iy [m⁴]",
     gui_group="FramAT: Cross-section properties",
 )
@@ -183,7 +194,7 @@
     unit=None,
     descr="Enter the maximum number of iterations of the aeroelastic-loop.",
     xpath=AEROFRAME_SETTINGS + "/MaxNumberIterations",
-    gui=True,
+    gui=INCLUDE_GUI,
     gui_name="Maximum number of iterations",
     gui_group="AeroFrame: Convergence settings",
 )
@@ -195,33 +206,7 @@
     unit=None,
     descr="Enter the tolerance for convergence of the wing deformation.",
     xpath=AEROFRAME_SETTINGS + "/Tolerance",
-    gui=True,
+    gui=INCLUDE_GUI,
     gui_name="Tolerance",
     gui_group="AeroFrame: Convergence settings",
 )
-
-# ----- Output -----
-
-cpacs_inout.add_output(
-    var_name="output",
-    default_value=None,
-    unit="1",
-    descr="Description of the output",
-    xpath=CEASIOMPY_XPATH + "/test/myOutput",
-)
-
-cpacs_inout.add_output(
-    var_name="aeromap_avl",  # name to change...
-    # var_type=CPACS_aeroMap, # no type pour output, would it be useful?
-    default_value=None,
-    unit="-",
-    descr="aeroMap with aero coefficients calculated by AVL",
-    xpath=AEROPERFORMANCE_XPATH + "/aeroMap/aeroPerformanceMap",
-)
-
-# =================================================================================================
-#    MAIN
-# =================================================================================================
-
-if __name__ == "__main__":
-    log.info("Nothing to be executed.")