Merge pull request #11 from Albatross-Kite-Transport/controlplots

replace Plots with ControlPlots

Author: 1-Bart-1

.github/workflows/CI.yml

@@ -34,6 +34,9 @@ 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
       - 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,20 +6,20 @@ 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"
 LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 Logging = "56ddb016-857b-54e1-b83d-db4d58db5568"
 Measures = "442fdcdd-2543-5da2-b0f3-8c86c306513e"
-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"
-Plots = "1"
 Statistics = "1"
 DelimitedFiles = "1"
 BenchmarkTools = "1"

README.md

@@ -1,5 +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) [![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 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 
@@ -116,7 +118,7 @@ Surfplan files can be converted to an input for `VortexStepMethod.jl` using the
 ## 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. 

Spanwise Distributions.pdf

@@ -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

docs/geometry.png

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

examples/rectangular_wing.jl

@@ -6,7 +6,7 @@ using Logging
 using Statistics
 using Colors
 using DelimitedFiles
-using Plots
+using ControlPlots
 using Measures
 using LaTeXStrings
 
@@ -18,6 +18,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
 
 """
    const MVec3    = MVector{3, Float64}
@@ -31,8 +32,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}}}
 
 # Include core functionality
 include("wing_geometry.jl")