move ControlPlots to extension

Author: ufechner7

Project.toml

@@ -5,7 +5,6 @@ version = "1.0.0"
 
 [deps]
 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"
@@ -20,6 +19,12 @@ StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 Timers = "21f18d07-b854-4dab-86f0-c15a3821819a"
 
+  [weakdeps]
+  ControlPlots = "23c2ee80-7a9e-4350-b264-8e670f12517c"
+  
+  [extensions]
+  VortexStepMethodExt = "ControlPlots"
+
 [compat]
 BenchmarkTools = "1"
 Colors = "0.13"

README.md

@@ -18,10 +18,10 @@ if you haven't already. On Linux, make sure that Python3, Matplotlib and LaTeX a
 sudo apt install python3-matplotlib
 sudo apt install texlive-full texlive-fonts-extra cm-super
 ```
-Furthermore, the package `TestEnv` must be installed globally:
-```
-julia -e 'using Pkg; Pkg.add("TestEnv")'
+Furthermore, the packages `TestEnv` and `ControlPlots` must be installed globally:
 ```
+julia -e 'using Pkg; Pkg.add("TestEnv"); Pkg.add(ControlPlots)'
+```)
 
 Before installing this software it is suggested to create a new project, for example like this:
 ```bash
@@ -62,6 +62,7 @@ Pkg.update()
 ```
 and then you can display a menu with the available examples:
 ```julia
+using ControlPlots
 using VortexStepMethod
 menu()
 ```

examples/stall_model.jl

@@ -43,7 +43,7 @@ end
 body_aero_CAD_19ribs = BodyAerodynamics([CAD_wing])
 
 # Create solvers
-VSM = Solver(
+vsm_solver = Solver(
     aerodynamic_model_type=VSM,
     is_with_artificial_damping=false
 )
@@ -78,7 +78,7 @@ plot && plot_geometry(
 )
 
 # Solving and plotting distributions
-results = solve(VSM, body_aero_CAD_19ribs)
+results = solve(vsm_solver, body_aero_CAD_19ribs)
 @time results_with_stall = solve(VSM_with_stall_correction, body_aero_CAD_19ribs)
 @time results_with_stall = solve(VSM_with_stall_correction, body_aero_CAD_19ribs)
 
@@ -106,7 +106,7 @@ path_cfd_lebesque = joinpath(
 )
 
 plot && plot_polars(
-    [VSM, VSM_with_stall_correction],
+    [vsm_solver, VSM_with_stall_correction],
     [body_aero_CAD_19ribs, body_aero_CAD_19ribs],
     [
         "VSM CAD 19ribs",

ext/VortexStepMethodExt.jl

@@ -0,0 +1,10 @@
+module VortexStepMethodExt
+using ControlPlots, LaTeXStrings, VortexStepMethod, LinearAlgebra, Statistics, DelimitedFiles
+import ControlPlots: plt
+import VortexStepMethod: calculate_filaments_for_plotting
+
+export plot_wing, plot_circulation_distribution, plot_geometry, plot_distribution, plot_polars
+
+include("../src/plotting.jl")
+
+end

results/TUDELFT_V3_LEI_KITE/polars/tutorial_testing_stall_model_n_panels_54_distribution_SPLIT_PROVIDED.pdf

@@ -6,7 +6,6 @@ using Logging
 using Statistics
 using Colors
 using DelimitedFiles
-using ControlPlots
 using Measures
 using LaTeXStrings
 using NonlinearSolve
@@ -22,11 +21,19 @@ export Solver, solve
 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, menu
 export Model, VSM, LLT
 export PanelDistribution, LINEAR, COSINE, COSINE_VAN_GARREL, SPLIT_PROVIDED, UNCHANGED
 
+export plot_geometry, plot_distribution, plot_circulation_distribution, plot_geometry, plot_polars
+
+# the following functions are defined in ext/VortexStepMethodExt.jl
+function plot_geometry end
+function plot_distribution end
+function plot_circulation_distribution end
+function plot_geometry end
+function plot_polars end
+
 """
    const MVec3    = MVector{3, Float64}
 
@@ -94,7 +101,4 @@ include("wake.jl")
 include("body_aerodynamics.jl")
 include("solver.jl")
 
-# include plotting
-include("plotting.jl")
-
 end # module

src/VortexStepMethod.jl

@@ -261,7 +261,7 @@ Plot wing geometry from different viewpoints and optionally save/show plots.
 - `view_azimuth`: initial view azimuth angle (default: -120) [°]
 
 """
-function plot_geometry(body_aero::BodyAerodynamics, title;
+function VortexStepMethod.plot_geometry(body_aero::BodyAerodynamics, title;
     data_type=".pdf",
     save_path=nothing,
     is_save=false,
@@ -317,7 +317,7 @@ Plot spanwise distributions of aerodynamic properties.
 - `is_save`: Whether to save plots (default: false)
 - `is_show`: Whether to display plots (default: true)
 """
-function plot_distribution(y_coordinates_list, results_list, label_list;
+function VortexStepMethod.plot_distribution(y_coordinates_list, results_list, label_list;
     title="spanwise_distribution",
     data_type=".pdf",
     save_path=nothing,
@@ -594,7 +594,7 @@ Plot polar data comparing different solvers and configurations.
 - `is_save`: Whether to save plots (default: true)
 - `is_show`: Whether to display plots (default: true)
 """
-function plot_polars(
+function VortexStepMethod.plot_polars(
     solver_list,
     body_aero_list,
     label_list;