Merge branch 'main' into feat/kite-obj

Author: 1-Bart-1

.github/workflows/CI.yml

@@ -34,6 +34,12 @@ jobs:
             arch: x64
             version: 1
     steps:
+      - name: Install matplotlib
+        run: if [ "$RUNNER_OS" = "Linux" ]; then sudo apt-get install -y python3-matplotlib; fi
+        shell: bash
+      - name: Install LaTeX
+        run: if [ "$RUNNER_OS" = "Linux" ]; then sudo apt-get -qq install texlive-full texlive-fonts-extra cm-super; fi
+        shell: bash
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v2
         with:

CITATION.cff

@@ -1,21 +1,20 @@
-cff-version: 0.1.0
+cff-version: 1.2.0
 message: "If you are using this software, please cite it as shown below."
 authors:
-  -
-    family-names: "Cayon"
+  - family-names: "Cayon"
     given-names: "Oriol"
     orcid: "https://orcid.org/0000-0002-2065-8673"
-    family-names: "Poland"
+  - family-names: "Poland"
     given-names: "Jelle Agatho Wilhelm"
     orcid: "https://orcid.org/0000-0003-3164-5648"
-title: "VortexStepMethod"
+title: "VortexStepMethod.jl"
 keywords:
-  - Airborne Wind Energy
-version: 0.1.0
+  - Airborne Wind Energy, AWE, AWES, Vortex step methods
+version: 1.0.0
 # doi: "11.1111/11111"
 # date-released: YYYY-MM-DD
 license: MIT
-url: "https://github.com/ocayon/Vortex-Step-Method"
+url: "https://github.com/Albatross-Kite-Transport/VortexStepMethod.jl"
 preferred-citation:
   type: article
   authors:
@@ -31,4 +30,3 @@ preferred-citation:
   issue: 7
   volume: 16
   year: 2023
-  article-number: 3061

Project.toml

@@ -6,14 +6,24 @@ version = "0.1.0"
 [deps]
 BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
 Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
+ControlPlots = "23c2ee80-7a9e-4350-b264-8e670f12517c"
 DelimitedFiles = "8bb1440f-4735-579b-a4ab-409b98df4dab"
 Interpolations = "a98d9a8b-a2ab-59e6-89dd-64a1c18fca59"
 LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 Logging = "56ddb016-857b-54e1-b83d-db4d58db5568"
 Measures = "442fdcdd-2543-5da2-b0f3-8c86c306513e"
 NonlinearSolve = "8913a72c-1f9b-4ce2-8d82-65094dcecaec"
-Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
 StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[compat]
+ControlPlots = "0.2.5"
+Measures = "0.3"
+StaticArrays = "1"
+Statistics = "1"
+DelimitedFiles = "1"
+BenchmarkTools = "1"
+LaTeXStrings = "1"
+Colors = "0.13"

README.md

@@ -1,6 +1,7 @@
-[![Build Status](https://github.com/Albatross-Kite-Transport/VortexStepMethod.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/Albatross-Kite-Transport/VortexStepMethod.jl/actions/workflows/CI.yml?query=branch%3Amain)
+[![Build Status](https://github.com/Albatross-Kite-Transport/VortexStepMethod.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/Albatross-Kite-Transport/VortexStepMethod.jl/actions/workflows/CI.yml?query=branch%3Amain) [![Coverage](https://codecov.io/gh/Albatross-Kite-Transport/VortexStepMethod.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/Albatross-Kite-Transport/VortexStepMethod.jl)
 
-# Simulation of a Kite using the Vortex Step Method
+
+# Simulation of a 3D airfoil using the Vortex Step Method
 
 The Vortex Step Method (VSM) is an enhanced lifting line method that improves upon the classic approach by solving the 
 circulation system at the three-quarter chord position, among the most important details. This adjustment allows for 
@@ -111,12 +112,12 @@ vel_app = [cos(alpha), 0.0, sin(alpha)] .* Umag
 set_va!(wa, (vel_app, 0.0))  # Second parameter is yaw rate
 ```
 
-Surfplan output file can be converted to an input for the vortex step method with a tool that is in this repo.
+Surfplan files can be converted to an input for `VortexStepMethod.jl` using the [SurfplanAdapter](https://github.com/jellepoland/SurfplanAdapter).
 
 ## Output
 - CL, CD, CS (side force coefficient)
 - the spanwise distribution of forces  
-  --> moment coefficients (not yet implemented)
+  --> moment coefficients (will be implemented in release 1.1) 
 
 ## Citation
 If you use this project in your research, please consider citing it. 
@@ -130,4 +131,4 @@ Copyright (c) 2022 Oriol Cayon
 
 Copyright (c) 2024 Oriol Cayon, Jelle Poland, TU Delft
 
-Copyright (c) 2025 Oriol Cayon, Jelle Poland, Bart van de Lint
+Copyright (c) 2025 Oriol Cayon, Jelle Poland, Bart van de Lint

docs/geometry.png

@@ -1,5 +1,5 @@
 using LinearAlgebra
-using Plots
+using ControlPlots
 using VortexStepMethod
 
 # Step 1: Define wing parameters
@@ -55,36 +55,33 @@ println("Projected area = $(round(results_vsm["projected_area"], digits=4)) m²"
 # Step 6: Plot geometry
 plot_geometry(
       wa,
-      "rectangular_wing_geometry";
+      "Rectangular_wing_geometry";
       data_type=".pdf",
       save_path=".",
       is_save=false,
       is_show=true,
 )
+nothing
 
-# # Step 7: Plot spanwise distributions
-# y_coordinates = [panel.aerodynamic_center[2] for panel in wa.panels]
+# Step 7: Plot spanwise distributions
+y_coordinates = [panel.aerodynamic_center[2] for panel in wa.panels]
 
-# plot_distribution(
-#     [y_coordinates, y_coordinates],
-#     [results_vsm, results_llt],
-#     ["VSM", "LLT"],
-#     title="Spanwise Distributions"
-# )
-
-# # Step 8: Plot polar curves
-# angle_range = range(0, 20, 20)
-# plot_polars(
-#     [llt_solver, vsm_solver],
-#     [wa, wa],
-#     ["LLT", "VSM"],
-#     angle_range=angle_range,
-#     angle_type="angle_of_attack",
-#     Umag=Umag,
-#     title="Rectangular Wing Polars"
-# )
+plot_distribution(
+    [y_coordinates, y_coordinates],
+    [results_vsm, results_llt],
+    ["VSM", "LLT"],
+    title="Spanwise Distributions"
+)
 
-# Save plots if needed
-# savefig("geometry.pdf")
-# savefig("distributions.pdf")
-# savefig("polars.pdf")
+# Step 8: Plot polar curves
+angle_range = range(0, 20, 20)
+plot_polars(
+    [llt_solver, vsm_solver],
+    [wa, wa],
+    ["LLT", "VSM"],
+    angle_range=angle_range,
+    angle_type="angle_of_attack",
+    Umag=Umag,
+    title="Rectangular Wing Polars"
+)
+nothing

examples/rectangular_wing.jl

@@ -3,7 +3,6 @@ using VortexStepMethod
 using CSV
 using DataFrames
 using LinearAlgebra
-using Plots
 
 # Find root directory
 root_dir = dirname(@__DIR__)

examples/testing_stall_model.jl

@@ -6,7 +6,7 @@ using Logging
 using Statistics
 using Colors
 using DelimitedFiles
-using Plots
+using ControlPlots
 using Measures
 using LaTeXStrings
 using NonlinearSolve
@@ -20,6 +20,7 @@ export calculate_results, solve_circulation_distribution
 export add_section!, set_va!
 export calculate_span, calculate_projected_area
 export plot_wing, plot_circulation_distribution, plot_geometry, plot_distribution, plot_polars
+export show_plot, save_plot
 
 """
    const MVec3    = MVector{3, Float64}
@@ -33,8 +34,8 @@ const MVec3    = MVector{3, Float64}
 
 Position vector, either a `MVec3` or a `Vector` for use in function signatures.
 """
-const PosVector=Union{MVec3, Vector}
-const VelVector=Union{MVec3, Vector}
+const PosVector=Union{MVec3, Vector, SizedVector{3, Float64, Vector{Float64}}}
+const VelVector=Union{MVec3, Vector, SizedVector{3, Float64, Vector{Float64}}}
 
 abstract type AbstractWing end
 

results/TUDELFT_V3_LEI_KITE/polars/$C_L$ vs $C_D$.pdf

@@ -69,41 +69,37 @@ end
 
 Set the default style for plots using LaTeX.
 """
-function set_plot_style()
-    default(
-        fontfamily="Computer Modern",
-        titlefontsize=14,
-        guidefontsize=12,
-        tickfontsize=10,
-        legendfontsize=10,
-        linewidth=1,
-        markersize=6,
-        size=(600, 400),
-        grid=true,
-        gridstyle=:dash,
-        gridcolor=:gray,
-        gridalpha=0.3
-    )
-    
-    # LaTeX settings if using PGFPlotsX backend
-    if backend() isa PGFPlotsX
-        pgfplotsx(
-            tex_output_standalone=true,
-            pdf_engine="pdflatex",
-            latex_engine="pdflatex"
-        )
-    end
+function set_plot_style(titel_size=16)
+    # plt.style.use('seaborn-whitegrid')
+    # plt.style.use("seaborn-v0_8-whitegrid")
+    rcParams = plt.PyDict(plt.matplotlib."rcParams")
+    rcParams["text.usetex"] = true
+    rcParams["font.family"] = "serif"
+    rcParams["font.serif"] = ["Computer Modern Roman"]
+    rcParams["axes.titlesize"] = titel_size
+    # rcParams["axes.ymargin"] = 0.1
+    rcParams["axes.labelsize"] = 12
+    rcParams["axes.linewidth"] = 1
+    rcParams["lines.linewidth"] = 1
+    rcParams["lines.markersize"] = 6
+    rcParams["xtick.labelsize"] = 10
+    rcParams["ytick.labelsize"] = 10
+    rcParams["legend.fontsize"] = 10
+    rcParams["figure.titlesize"] = 16
+    rcParams["pgf.texsystem"] = "pdflatex"  # Use pdflatex
+    rcParams["pgf.rcfonts"] = false
+    rcParams["figure.figsize"] = (10, 6)  # Default figure size
 end
 
-"""
-    apply_palette!(p::Plots.Plot, colors::Vector{String})
+# """
+#     apply_palette!(p::Plots.Plot, colors::Vector{String})
 
-Apply the color palette to a plot.
-"""
-function apply_palette!(p::Plots.Plot, colors::Vector{String})
-    for (i, series) in enumerate(p.series_list)
-        color_name = colors[mod1(i, length(colors))]
-        series.plotattributes[:linecolor] = get_color(color_name)
-    end
-    return p
-end
+# Apply the color palette to a plot.
+# """
+# function apply_palette!(p::Plots.Plot, colors::Vector{String})
+#     for (i, series) in enumerate(p.series_list)
+#         color_name = colors[mod1(i, length(colors))]
+#         series.plotattributes[:linecolor] = get_color(color_name)
+#     end
+#     return p
+# end