Add Aqua.jl for quality assurance (#112)

* add aqua

* Add compat bounds

* All tests pass now

* Add button to README.md

---------

Co-authored-by: Uwe Fechner <[email protected]>

Author: ufechner7

Project.toml

@@ -19,7 +19,6 @@ Serialization = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
 SharedArrays = "1a1011a3-84de-559e-8e89-a11a2f7dc383"
 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"
@@ -28,31 +27,44 @@ ControlPlots = "23c2ee80-7a9e-4350-b264-8e670f12517c"
 VortexStepMethodControlPlotsExt = "ControlPlots"
 
 [compat]
+Aqua = "0.8"
 BenchmarkTools = "1"
 Colors = "0.13"
 ControlPlots = "0.2.5"
+CSV = "0.10"
+DataFrames = "1.7"
 DefaultApplication = "1"
 DelimitedFiles = "1"
+Distributed = "1.10"
+Documenter = "1.8"
 Interpolations = "0.15"
 LaTeXStrings = "1"
+LinearAlgebra = "1"
+Logging = "1"
 Measures = "0.3"
 NonlinearSolve = "4"
 Parameters = "0.12"
 Pkg = "1"
+Serialization = "1"
+SharedArrays = "1"
 StaticArrays = "1"
 Statistics = "1"
 Timers = "0.1"
+Test = "1"
+Xfoil = "0.5"
 julia = "1.10, 1.11"
 
 [extras]
+Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
 BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
 CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
 ControlPlots = "23c2ee80-7a9e-4350-b264-8e670f12517c"
 DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 Distributed = "8ba89e20-285c-5b6f-9357-94700520ee1b"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+Timers = "21f18d07-b854-4dab-86f0-c15a3821819a"
 Xfoil = "19641d66-a62d-11e8-2441-8f57a969a9c4"
 
 [targets]
-test = ["Test", "DataFrames", "CSV", "Distributed", "Documenter", "Xfoil", "BenchmarkTools", "ControlPlots"]
+test = ["Test", "DataFrames", "CSV", "Distributed", "Documenter", "Xfoil", "Timers", "BenchmarkTools", "ControlPlots", "Aqua"]

README.md

@@ -1,4 +1,8 @@
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://Albatross-Kite-Transport.github.io/VortexStepMethod.jl/stable) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://Albatross-Kite-Transport.github.io/VortexStepMethod.jl/dev) [![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)
+[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://Albatross-Kite-Transport.github.io/VortexStepMethod.jl/stable)
+[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://Albatross-Kite-Transport.github.io/VortexStepMethod.jl/dev)
+[![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)
+[![Aqua QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
 
 
 # Aerodynamic models of 3D wings using the Vortex Step Method 

examples/menu.jl

@@ -1,28 +1,15 @@
 using ControlPlots
 using VortexStepMethod
 using REPL.TerminalMenus
-using DefaultApplication
 
 url = "https://albatross-kite-transport.github.io/VortexStepMethod.jl/dev"
 
-function help() 
-    if Sys.islinux()
-        io = IOBuffer()
-        run(pipeline(`xdg-open $url`, stderr = io))
-        # ignore any error messages
-        out_data = String(take!(io)) 
-    else
-        DefaultApplication.open(url)
-    end
-    nothing
-end
-
 options = ["rectangular_wing = include(\"rectangular_wing.jl\")",
            "ram_air_kite = include(\"ram_air_kite.jl\")",
            "stall_model = include(\"stall_model.jl\")",
            "bench = include(\"bench.jl\")",
            "cleanup = include(\"cleanup.jl\")",
-           "help_me = help()",
+           "help_me = VortexStepMethod.help(url)",
            "quit"]
 
 function example_menu()

src/VortexStepMethod.jl

@@ -6,6 +6,7 @@ using Logging
 using Statistics
 using Colors
 using DelimitedFiles
+using DefaultApplication
 using Measures
 using LaTeXStrings
 using NonlinearSolve
@@ -20,7 +21,7 @@ using Pkg
 export Wing, Section, KiteWing
 export BodyAerodynamics
 export Solver, solve, solve_base, solve!, VSMSolution
-export calculate_results, solve_circulation_distribution
+export calculate_results
 export add_section!, set_va!
 export calculate_span, calculate_projected_area
 export menu, MVec3
@@ -218,6 +219,18 @@ function copy_files(relpath, files)
     files
 end
 
+function help(url) 
+    if Sys.islinux()
+        io = IOBuffer()
+        run(pipeline(`xdg-open $url`, stderr = io))
+        # ignore any error messages
+        out_data = String(take!(io)) 
+    else
+        DefaultApplication.open(url)
+    end
+    nothing
+end
+
 # Include core functionality
 include("wing_geometry.jl")
 include("kite_geometry.jl")

test/aqua.jl

@@ -0,0 +1,2 @@
+using Aqua
+Aqua.test_all(VortexStepMethod)

test/runtests.jl

@@ -11,4 +11,5 @@ println("Running tests...")
     include("test_kite_geometry.jl")
     include("test_wing_geometry.jl")
     include("test_plotting.jl")
+    include("aqua.jl")
 end