Add Aqua tests and other various improvements (#67)

* Add Aqua tests

* Remove non-existing exports

* Create `examples/Project.toml` and remove stale deps from main env

* Add missing compat bound for test dep

* Split test environment into `test/Project.toml`

* [CI] Run validation with Julia v1.12 and activate right environment

Also, correct list of triggers.

Author: giordano

.github/workflows/Validation.yml

@@ -6,13 +6,17 @@ on:
       - "main"
     paths:
       - ".github/workflows/Validation.yml"
+      - "examples/Project.jl"
+      - "examples/bomex.jl"
       - "ext/**"
       - "src/**"
       - "test/**"
       - "Project.toml"
   pull_request:
     paths:
       - ".github/workflows/Validation.yml"
+      - "examples/Project.jl"
+      - "examples/bomex.jl"
       - "ext/**"
       - "src/**"
       - "test/**"
@@ -40,7 +44,7 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - "min"
+          - "1.12"
         os:
           - ubuntu-latest
     steps:
@@ -50,17 +54,17 @@ jobs:
           version: ${{ matrix.version }}
       - uses: julia-actions/cache@v2
         id: julia-cache
-      - name: Add CairoMakie to Project.toml
-        shell: julia --color=yes --project {0}
+      - name: Instantiate examples environment
+        shell: julia --color=yes --project=examples {0}
         run: |
           using Pkg
-          Pkg.add("CairoMakie")
+          Pkg.instantiate()
       - name: Run BOMEX example
         env:
           VALIDATION: "true"
           CI: "true"
         run: |
-          julia --color=yes --project=. examples/bomex.jl
+          julia --color=yes --project=examples examples/bomex.jl
       - name: Save Julia depot cache on cancel or failure
         id: julia-cache-save
         if: cancelled() || failure()

Project.toml

@@ -5,25 +5,15 @@ authors = ["Navid C. Constantinou <[email protected]>, Gregory L.
 
 [deps]
 Adapt = "79e6a3ab-5dfb-504d-930d-738a2a938a0e"
-AtmosphericProfilesLibrary = "86bc3604-9858-485a-bdbe-831ec50de11d"
-CloudMicrophysics = "6a9e3e04-43cd-43ba-94b9-e8782df3c71b"
 JLD2 = "033835bb-8acc-5ee8-8aae-3f567f8a3819"
 KernelAbstractions = "63c18a36-062a-441e-b654-da1e3ab1ce7c"
 Oceananigans = "9e8cae18-63c1-5223-a75c-80ca9d6e9a09"
 Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
 
 [compat]
 Adapt = "4.3.0"
-AtmosphericProfilesLibrary = "0.1.7"
-CloudMicrophysics = "0.22.13, 0.29"
 JLD2 = "0.5.13, 0.6"
 KernelAbstractions = "0.9"
 Oceananigans = "0.100"
 Printf = "1"
 julia = "1.10.10"
-
-[extras]
-Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
-
-[targets]
-test = ["Test"]

examples/Project.toml

@@ -0,0 +1,16 @@
+[deps]
+AtmosphericProfilesLibrary = "86bc3604-9858-485a-bdbe-831ec50de11d"
+Breeze = "660aa2fb-d4c8-4359-a52c-9c057bc511da"
+CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
+CloudMicrophysics = "6a9e3e04-43cd-43ba-94b9-e8782df3c71b"
+GLMakie = "e9467ef8-e4e7-5192-8a1a-b1aee30e663a"
+JLD2 = "033835bb-8acc-5ee8-8aae-3f567f8a3819"
+Oceananigans = "9e8cae18-63c1-5223-a75c-80ca9d6e9a09"
+Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
+
+[sources]
+Breeze = {path = ".."}
+
+[compat]
+AtmosphericProfilesLibrary = "0.1.7"
+CloudMicrophysics = "0.22.13, 0.29"

src/Breeze.jl

@@ -13,7 +13,6 @@ export
     AtmosphereModel,
     TemperatureField,
     IdealGas,
-    PhaseTransitionConstants,
     CondensedPhase,
     mixture_gas_constant,
     mixture_heat_capacity
@@ -26,7 +25,7 @@ export
     Center, Face, Periodic, Bounded, Flat,
     RectilinearGrid,
     nodes, xnodes, ynodes, znodes,
-    xnode, ynode, znode,
+    znode,
     xspacings, yspacings, zspacings,
     minimum_xspacing, minimum_yspacing, minimum_zspacing,
     ImmersedBoundaryGrid, GridFittedBottom, PartialCellBottom, ImmersedBoundaryCondition,
@@ -39,7 +38,7 @@ export
     BackgroundField, interior, set!, compute!, regrid!,
     Forcing,
     FPlane, ConstantCartesianCoriolis, BetaPlane, NonTraditionalBetaPlane,
-    SmagorinskyLilly, DynamicSmagorinsky, AnisotropicMinimumDissipation,
+    SmagorinskyLilly, AnisotropicMinimumDissipation,
     LagrangianParticles,
     conjure_time_step_wizard!,
     time_step!, Simulation, run!, Callback, add_callback!, iteration,

src/Thermodynamics/Thermodynamics.jl

@@ -1,7 +1,7 @@
 module Thermodynamics
 
 export ThermodynamicConstants, ReferenceStateConstants, IdealGas,
-       PhaseTransitionConstants, CondensedPhase,
+       CondensedPhase,
        mixture_gas_constant, mixture_heat_capacity
 
 include("atmosphere_thermodynamics.jl")

test/Project.toml

@@ -0,0 +1,9 @@
+[deps]
+Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
+Oceananigans = "9e8cae18-63c1-5223-a75c-80ca9d6e9a09"
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[compat]
+Aqua = "0.8"
+Oceananigans = "0.100"
+Test = "<0.0.1, 1"

test/aqua.jl

@@ -0,0 +1,4 @@
+using Breeze: Breeze
+using Aqua: Aqua
+
+Aqua.test_all(Breeze)

test/runtests.jl

@@ -2,6 +2,8 @@ using Test
 using Breeze
 using Oceananigans
 
+include("aqua.jl")
+
 @testset "Breeze.jl" begin
     @testset "Thermodynamics" begin
         thermo = ThermodynamicConstants()