feat: add general show methods for param structs

Author: haakon-e

src/parameters/AbstractTypes.jl

@@ -9,6 +9,10 @@ abstract type ParametersType end
 # Temporary fallback until we stop checking eltype from the parameters
 Base.eltype(p::ParametersType) = fieldcount(typeof(p)) > 0 ? eltype(getfield(p, 1)) : Any
 Base.broadcastable(x::ParametersType) = tuple(x)
+Base.show(io::IO, x::ParametersType) =
+    ShowMethods.parseable_show_with_fields_no_type_header(io, x; with_module_prefix = false)
+Base.show(io::IO, mime::MIME"text/plain", x::ParametersType) =
+    ShowMethods.show_type_and_fields(io, mime, x)
 
 """
     AerosolType

src/parameters/AirProperties.jl

@@ -11,12 +11,14 @@ $(DocStringExtensions.FIELDS)
 @kwdef struct AirProperties{FT} <: ParametersType
     "thermal conductivity of air [w/m/K]"
     K_therm::FT
-    "diffusivity of water vapor [m2/s]"
+    "diffusivity of water vapor [m²/s]"
     D_vapor::FT
-    "kinematic viscosity of air [m2/s]"
+    "kinematic viscosity of air [m²/s]"
     ν_air::FT
 end
 
+ShowMethods.field_units(::AirProperties) =
+    (; K_therm = "W/m/K", D_vapor = "m²/s", ν_air = "m²/s")
 
 function AirProperties(td::CP.ParamDict)
     name_map = (;

src/parameters/Microphysics1M.jl

@@ -178,6 +178,8 @@ $(DocStringExtensions.FIELDS)
     "assumed number concentration for cloud sedimentation [1/m3]"
     N_0::FT
 end
+Base.show(io::IO, mime::MIME"text/plain", vel::CloudIce) =
+    ShowMethods.verbose_show_type_and_fields(io, mime, vel)
 
 function CloudIce(toml_dict::CP.ParamDict)
     name_map = (;

src/parameters/Microphysics1MParams.jl

@@ -14,6 +14,9 @@ Parameters for cloud-phase (non-precipitating) hydrometeors in 1-moment scheme.
     ice::ICL
 end
 
+Base.show(io::IO, mime::MIME"text/plain", x::CloudPhaseParams1M) =
+    ShowMethods.verbose_show_type_and_fields(io, mime, x)
+
 """
     PrecipPhaseParams1M{FT, RAI, SNO}
 
@@ -28,6 +31,9 @@ Parameters for precipitating hydrometeors in 1-moment scheme.
     snow::SNO
 end
 
+Base.show(io::IO, mime::MIME"text/plain", x::PrecipPhaseParams1M) =
+    ShowMethods.verbose_show_type_and_fields(io, mime, x)
+
 """
     Microphysics1MParams{FT, CP, PP, CE, AP, VL, VA}
 
@@ -62,6 +68,8 @@ mp_with_2M = CMP.Microphysics1MParams(Float64; with_2M_autoconv = true)
     autoconv_2M::VA
     prescribed_Nc::FT
 end
+Base.show(io::IO, mime::MIME"text/plain", x::Microphysics1MParams) =
+    ShowMethods.verbose_show_type_and_fields(io, mime, x)
 
 """
     Microphysics1MParams(toml_dict::CP.ParamDict; with_2M_autoconv = false)

src/parameters/Microphysics2M.jl

@@ -324,6 +324,9 @@ RainParticlePDF_SB2006(toml_dict::CP.ParamDict; is_limited = true) =
     RainParticlePDF_SB2006_limited(toml_dict) :
     RainParticlePDF_SB2006_notlimited(toml_dict)
 
+Base.show(io::IO, mime::MIME"text/plain", x::RainParticlePDF_SB2006) =
+    ShowMethods.verbose_show_type_and_fields(io, mime, x)
+
 """
     RainParticlePDF_SB2006_limited
 
@@ -653,6 +656,8 @@ $(DocStringExtensions.FIELDS)
     "Number concentration adjustment parameter"
     numadj::NA
 end
+Base.show(io::IO, mime::MIME"text/plain", x::SB2006) =
+    ShowMethods.verbose_show_type_and_fields(io, mime, x)
 
 # Construct SB2006 from a ClimaParams TOML dict
 SB2006(toml_dict::CP.ParamDict; is_limited = true) =

src/parameters/Microphysics2MParams.jl

@@ -20,6 +20,9 @@ WarmRainParams2M(toml_dict::CP.ParamDict; is_limited = true) =
         air_properties = AirProperties(toml_dict),
     )
 
+Base.show(io::IO, mime::MIME"text/plain", x::WarmRainParams2M) =
+    ShowMethods.verbose_show_type_and_fields(io, mime, x)
+
 """
     P3IceParams
 
@@ -37,6 +40,8 @@ Parameters for P3 ice-phase processes (optional).
     cloud_pdf::PDc
     rain_pdf::PDr
 end
+Base.show(io::IO, mime::MIME"text/plain", x::P3IceParams) =
+    ShowMethods.verbose_show_type_and_fields(io, mime, x)
 
 P3IceParams(toml_dict::CP.ParamDict; is_limited = true) =
     P3IceParams(;
@@ -73,6 +78,8 @@ mp_p3 = CMP.Microphysics2MParams(Float64; with_ice = true)
     warm_rain::WR
     ice::ICE
 end
+Base.show(io::IO, mime::MIME"text/plain", x::Microphysics2MParams) =
+    ShowMethods.verbose_show_type_and_fields(io, mime, x)
 
 """
     Microphysics2MParams(::Type{FT}; with_ice = false, is_limited = true) where {FT <: AbstractFloat}

src/parameters/MicrophysicsP3.jl

@@ -306,67 +306,15 @@ end
 ### ----- UTILS ----- ###
 ### ----------------- ###
 
-function Base.show(
-    io::IO,
-    p::Union{
-        ParametersP3,
-        MassPowerLaw,
-        AreaPowerLaw,
-        SlopePowerLaw,
-        SlopeConstant,
-        VentilationFactor,
-        LocalRimeDensity,
-    },
-)
-    indent = get(io, :indent, "")
-    prefix = get(io, :prefix, "")
-
-    # Get type information
-    T = typeof(p)
-    FT = eltype(p)
-    type = (FT != get(io, :typeinfo, Any)) ? "{$FT}" : ""
-
-    # Print type name, handling nested types
-    type_name = T.name.name
-    println(io, "$(prefix)$(type_name)$type")
-
-    # Print each field
-    fields = fieldnames(T)
-    for (i, field) in enumerate(fields)
-        value = getfield(p, field)
-        is_last = i == length(fields)
-        prefix_char = is_last ? "└" : "├"
-
-        if typeof(value) <: Number
-            # Simple value - print directly with unit
-            unit = _get_parameter_unit(field)
-            println(
-                io,
-                "$(indent)$(prefix_char)── $(field) = $(value) [$(unit)]",
-            )
-        else
-            # Nested struct - recursively show with proper context
-            nested_io = IOContext(
-                io,
-                :prefix => "$(prefix_char)── $(field): ",
-                :indent => "$(indent)│   ",
-                :typeinfo => FT,
-            )
-            show(nested_io, value)
-        end
-    end
-end
-
-function _get_parameter_unit(field::Symbol)
-    units = Dict(
-        :α_va => "kg μm^(-β_va)",
-        :γ => "μm^(2-σ)",
-        :a => "m^b",
-        :τ_wet => "s",
-        :ρ_i => "kg m⁻³",
-        :ρ_l => "kg m⁻³",
-        :T_freeze => "K",
-    )
-    # unitless parameters: β_va, σ, b, c, μ_max, μ, aᵥ, bᵥ
-    return get(units, field, "-")
-end
+Base.show(io::IO, mime::MIME"text/plain", p::ParametersP3) =
+    ShowMethods.verbose_show_type_and_fields(io, mime, p)
+
+# Unit annotations for verbose show (used by ShowMethods.verbose_show_type_and_fields)
+ShowMethods.field_units(::MassPowerLaw) = (; α_va = "kg m^(-β_va)")
+ShowMethods.field_units(::AreaPowerLaw) = (; γ = "μm^(2-σ)")
+ShowMethods.field_units(::SlopePowerLaw) = (; a = "m^b")
+ShowMethods.field_units(::SlopeConstant) = (;)
+ShowMethods.field_units(::VentilationFactor) = (;)
+ShowMethods.field_units(::LocalRimeDensity) = (; ρ_ice = "kg m⁻³")
+ShowMethods.field_units(::ParametersP3) =
+    (; τ_wet = "s", ρ_i = "kg m⁻³", ρ_l = "kg m⁻³", T_freeze = "K")

src/parameters/Parameters.jl

@@ -10,6 +10,9 @@ using DocStringExtensions
 import ClimaParams as CP
 import SpecialFunctions as SF
 
+include("../show.jl")
+import .ShowMethods
+
 # Super-types (dispatch, broadcasting, etc...)
 include("AbstractTypes.jl")
 

src/parameters/TerminalVelocity.jl

@@ -31,6 +31,8 @@ $(DocStringExtensions.FIELDS)
     "pre-computed gamma(ae + ve + Δa + Δv + 1) for accretion [-]"
     gamma_accr::FT
 end
+Base.show(io::IO, mime::MIME"text/plain", vel::Blk1MVelTypeRain) =
+    ShowMethods.verbose_show_type_and_fields(io, mime, vel)
 
 function Blk1MVelTypeRain(td::CP.ParamDict)
     vel_map = (;
@@ -86,6 +88,8 @@ $(DocStringExtensions.FIELDS)
     "pre-computed gamma(ae + ve + Δa + Δv + 1) for accretion [-]"
     gamma_accr::FT
 end
+Base.show(io::IO, mime::MIME"text/plain", vel::Blk1MVelTypeSnow) =
+    ShowMethods.verbose_show_type_and_fields(io, mime, vel)
 
 function Blk1MVelTypeSnow(td::CP.ParamDict)
     vel_map = (;
@@ -127,6 +131,8 @@ $(DocStringExtensions.FIELDS)
     rain::R
     snow::S
 end
+Base.show(io::IO, mime::MIME"text/plain", x::Blk1MVelType) =
+    ShowMethods.verbose_show_type_and_fields(io, mime, x)
 
 Blk1MVelType(toml_dict::CP.ParamDict) =
     Blk1MVelType(;
@@ -209,6 +215,8 @@ $(DocStringExtensions.FIELDS)
     "cutoff for small vs large ice particle dimension [m]"
     cutoff::FT
 end
+Base.show(io::IO, mime::MIME"text/plain", x::Chen2022VelTypeSmallIce) =
+    ShowMethods.verbose_show_type_and_fields(io, mime, x)
 
 function Chen2022VelTypeSmallIce(td::CP.ParamDict)
     # TODO: These should be array parameters.
@@ -286,6 +294,8 @@ $(DocStringExtensions.FIELDS)
     b_ρ::FT
     c::NTuple{N, FT}
 end
+Base.show(io::IO, mime::MIME"text/plain", x::Chen2022VelTypeRain) =
+    ShowMethods.verbose_show_type_and_fields(io, mime, x)
 
 function Chen2022VelTypeRain(td::CP.ParamDict)
     name_map = (;
@@ -325,6 +335,9 @@ Chen2022VelType(toml_dict::CP.ParamDict) =
         large_ice = Chen2022VelTypeLargeIce(toml_dict),
     )
 
+Base.show(io::IO, mime::MIME"text/plain", x::Chen2022VelType) =
+    ShowMethods.verbose_show_type_and_fields(io, mime, x)
+
 """
     TerminalVelocityParams