skip ci

Author: amaurigmartins

Project.toml

@@ -15,11 +15,13 @@ DisplayAs = "0b91fe84-8a4c-11e9-3e1d-67c38462b6d6"
 DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
 EzXML = "8f5d6c58-4d21-5cfd-889c-e3ad7ee6a615"
 ForceImport = "9dda63f9-cce7-5873-89fa-eccbb2fffcde"
+GetDP = "dbfd83e6-7aba-450b-9c2b-93ccd973023a"
 Gmsh = "705231aa-382f-11e9-3f0c-b7cb4346fdeb"
 JSON3 = "0f8b85d8-7281-11e9-16c2-39a750bddbf1"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 Logging = "56ddb016-857b-54e1-b83d-db4d58db5568"
 LoggingExtras = "e6f89c97-d47a-5376-807f-9c37f3926c36"
+MacroTools = "1914dd2f-81c6-5fcd-8719-6d5c9610ff09"
 Measurements = "eff96d63-e80a-5855-80a2-b1b0885c5ab7"
 Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
 PkgTemplates = "14b8a8f1-9102-5b29-a752-f990bacb7fe1"
@@ -30,10 +32,9 @@ Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
 Serialization = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
 SpecialFunctions = "276daf66-3868-5448-9aa4-cd146d93841b"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
-GetDP = "dbfd83e6-7aba-450b-9c2b-93ccd973023a"
 
 [sources]
-GetDP = {url = "https://github.com/Electa-Git/GetDP.jl", rev="main"}
+GetDP = {rev = "main", url = "https://github.com/Electa-Git/GetDP.jl"}
 
 [compat]
 CSV = "0.10.15"
@@ -51,6 +52,7 @@ JSON3 = "1.14.2"
 LinearAlgebra = "1.11.0"
 Logging = "1.11.0"
 LoggingExtras = "1.1.0"
+MacroTools = "0.5.16"
 Measurements = "2.11.0"
 Pkg = "1.11.0"
 PkgTemplates = "0.7.56"

src/DataModel.jl

@@ -44,13 +44,10 @@ using DataFrames
 using Colors
 using Plots
 using DisplayAs: DisplayAs
-import DataFrames: DataFrame
-import Base: get, delete!, length, setindex!, iterate, keys, values, haskey, getindex
-
 using ..Utils
 using ..Materials
 using ..EarthProps
-import ..LineCableModels: add!, preview, save, _is_headless, _is_in_testset, _CLEANMETHODLIST
+import ..LineCableModels: _is_headless, _is_in_testset, _CLEANMETHODLIST
 
 # To handle radius-related operations
 abstract type AbstractRadius end

src/DataModel/BaseParams.jl

@@ -88,7 +88,7 @@ alpha_eq = $(FUNCTIONNAME)(alpha_conductor, R_conductor, alpha_new_part, R_new_p
 println(alpha_eq)  # Output: 0.00396 (approximately)
 ```
 """
-@measurify function calc_equivalent_alpha(alpha1::T, R1::T, alpha2::T, R2::T) where {T<:REALTYPES}
+@measurify function calc_equivalent_alpha(alpha1::T, R1::T, alpha2::T, R2::T) where {T<:REALSCALAR}
     return (alpha1 * R2 + alpha2 * R1) / (R1 + R2)
 end
 
@@ -135,7 +135,7 @@ println(Req) # Outputs: 3.3333333333333335
 
 - [`calc_helical_params`](@ref)
 """
-function calc_parallel_equivalent(Z1::T, Z2::T) where {T<:Union{REALTYPES,COMPLEXTYPES}}
+function calc_parallel_equivalent(Z1::T, Z2::T) where {T<:Union{REALSCALAR,COMPLEXSCALAR}}
     return 1 / (1 / Z1 + 1 / Z2)
 end
 
@@ -188,7 +188,7 @@ mean_diam, pitch, overlength = $(FUNCTIONNAME)(radius_in, radius_ext, lay_ratio)
 # overlength > 1.0 [1/m]
 ```
 """
-function calc_helical_params(radius_in::T, radius_ext::T, lay_ratio::T) where {T<:REALTYPES}
+function calc_helical_params(radius_in::T, radius_ext::T, lay_ratio::T) where {T<:REALSCALAR}
     mean_diameter = 2 * (radius_in + (radius_ext - radius_in) / 2)
     pitch_length = lay_ratio * mean_diameter
     overlength = pitch_length != 0 ? sqrt(1 + (π * mean_diameter / pitch_length)^2) : 1
@@ -243,7 +243,7 @@ function calc_strip_resistance(
     alpha::T,
     T0::T,
     Top::T,
-) where {T<:REALTYPES}
+) where {T<:REALSCALAR}
 
     cross_section = thickness * width
     return calc_temperature_correction(alpha, Top, T0) * rho / cross_section
@@ -276,7 +276,7 @@ where ``\\alpha`` is the temperature coefficient of the material resistivity, ``
     k = $(FUNCTIONNAME)(0.00393, 75.0, 20.0)  # Expected output: 1.2158
 ```
 """
-function calc_temperature_correction(alpha::T, Top::T, T0::T=T₀) where {T<:REALTYPES}
+function calc_temperature_correction(alpha::T, Top::T, T0::T=T₀) where {T<:REALSCALAR}
     @assert abs(Top - T0) < ΔTmax """
     Temperature is outside the valid range for linear resistivity model:
     Top = $Top
@@ -333,7 +333,7 @@ function calc_tubular_resistance(
     alpha::T,
     T0::T,
     Top::T,
-) where {T<:REALTYPES}
+) where {T<:REALSCALAR}
     cross_section = π * (radius_ext^2 - radius_in^2)
     return calc_temperature_correction(alpha, Top, T0) * rho / cross_section
 end
@@ -372,7 +372,7 @@ L = $(FUNCTIONNAME)(radius_in, radius_ext, mu_r)
 
 - [`calc_tubular_resistance`](@ref)
 """
-function calc_tubular_inductance(radius_in::T, radius_ext::T, mu_r::T) where {T<:REALTYPES}
+function calc_tubular_inductance(radius_in::T, radius_ext::T, mu_r::T) where {T<:REALSCALAR}
     return mu_r * μ₀ / (2 * π) * log(radius_ext / radius_in)
 end
 
@@ -412,7 +412,7 @@ function calc_wirearray_coords(
     radius_wire::T,
     radius_in::T;
     C=(0.0, 0.0),
-) where {T<:REALTYPES}
+) where {T<:REALSCALAR}
     wire_coords = []  # Global coordinates of all wires
     lay_radius = num_wires == 1 ? 0 : radius_in + radius_wire
 
@@ -481,7 +481,7 @@ function calc_inductance_trifoil(
     S::T;
     rho_e::T=100.0,
     f::T=f₀,
-) where {T<:REALTYPES}
+) where {T<:REALSCALAR}
 
     ω = 2 * π * f
     C = μ₀ / (2π)
@@ -562,7 +562,7 @@ gmr = $(FUNCTIONNAME)(lay_rad, N, rad_wire, mu_r)
 println(gmr) # Expected output: 0.01187... [m]
 ```
 """
-function calc_wirearray_gmr(lay_rad::T, N::Int, rad_wire::T, mu_r::T) where {T<:REALTYPES}
+function calc_wirearray_gmr(lay_rad::T, N::Int, rad_wire::T, mu_r::T) where {T<:REALSCALAR}
     gmr_wire = rad_wire * exp(-mu_r / 4)
     log_gmr_array = log(gmr_wire * N * lay_rad^(N - 1)) / N
     return exp(log_gmr_array)
@@ -603,7 +603,7 @@ gmr = $(FUNCTIONNAME)(radius_ext, radius_in, mu_r)
 println(gmr) # Expected output: ~0.0135 [m]
 ```
 """
-function calc_tubular_gmr(radius_ext::T, radius_in::T, mu_r::T) where {T<:REALTYPES}
+function calc_tubular_gmr(radius_ext::T, radius_in::T, mu_r::T) where {T<:REALSCALAR}
     if radius_ext < radius_in
         throw(ArgumentError("Invalid parameters: radius_ext must be >= radius_in."))
     end
@@ -675,7 +675,7 @@ println(mu_r) # Expected output: ~1.5 [dimensionless]
 # See also
 - [`calc_tubular_gmr`](@ref)
 """
-function calc_equivalent_mu(gmr::T, radius_ext::T, radius_in::T) where {T<:REALTYPES}
+function calc_equivalent_mu(gmr::T, radius_ext::T, radius_in::T) where {T<:REALSCALAR}
     if radius_ext < radius_in
         throw(ArgumentError("Invalid parameters: radius_ext must be >= radius_in."))
     end
@@ -723,7 +723,7 @@ capacitance = $(FUNCTIONNAME)(radius_in, radius_ext, epsr)
 println(capacitance) # Expected output: ~1.24e-10 [F/m]
 ```
 """
-function calc_shunt_capacitance(radius_in::T, radius_ext::T, epsr::T) where {T<:REALTYPES}
+function calc_shunt_capacitance(radius_in::T, radius_ext::T, epsr::T) where {T<:REALSCALAR}
     return 2 * π * ε₀ * epsr / log(radius_ext / radius_in)
 end
 
@@ -757,7 +757,7 @@ g = $(FUNCTIONNAME)(radius_in, radius_ext, rho)
 println(g) # Expected output: 2.7169e-9 [S·m]
 ```
 """
-function calc_shunt_conductance(radius_in::T, radius_ext::T, rho::T) where {T<:REALTYPES}
+function calc_shunt_conductance(radius_in::T, radius_ext::T, rho::T) where {T<:REALSCALAR}
     return 2 * π * (1 / rho) / log(radius_ext / radius_in)
 end
 
@@ -943,7 +943,7 @@ function calc_solenoid_correction(
     num_turns::T,
     radius_ext_con::T,
     radius_ext_ins::T,
-) where {T<:REALTYPES}
+) where {T<:REALSCALAR}
     if isnan(num_turns)
         return 1.0
     else
@@ -980,7 +980,7 @@ where ``S_{eff}`` is the effective cross-sectional area of the tubular conductor
 rho_eq = $(FUNCTIONNAME)(0.01, 0.02, 0.01)  # Expected output: ~9.42e-4 [Ω·m]
 ```
 """
-function calc_equivalent_rho(R::T, radius_ext_con::T, radius_in_con::T) where {T<:REALTYPES}
+function calc_equivalent_rho(R::T, radius_ext_con::T, radius_in_con::T) where {T<:REALSCALAR}
     eff_conductor_area = π * (radius_ext_con^2 - radius_in_con^2)
     return R * eff_conductor_area
 end
@@ -1015,7 +1015,7 @@ eps_eq = $(FUNCTIONNAME)(1e-10, 0.01, 0.005)  # Expected output: ~2.26 [dimensio
 # See also
 - [`ε₀`](@ref)
 """
-function calc_equivalent_eps(C_eq::T, radius_ext::T, radius_in::T) where {T<:REALTYPES}
+function calc_equivalent_eps(C_eq::T, radius_ext::T, radius_in::T) where {T<:REALSCALAR}
     return (C_eq * log(radius_ext / radius_in)) / (2 * pi) / ε₀
 end
 
@@ -1046,7 +1046,7 @@ where ``\\tan \\delta`` is the loss factor (tangent).
 loss_factor = $(FUNCTIONNAME)(1e-8, 1e-10, 2π*50)  # Expected output: ~0.0318 [dimensionless]
 ```
 """
-function calc_equivalent_lossfact(G_eq::T, C_eq::T, ω::T) where {T<:REALTYPES}
+function calc_equivalent_lossfact(G_eq::T, C_eq::T, ω::T) where {T<:REALSCALAR}
     return G_eq / (ω * C_eq)
 end
 
@@ -1077,7 +1077,7 @@ Geq = 2.7169e-9
 sigma_eq = $(FUNCTIONNAME)(G_eq, radius_in, radius_ext)
 ```
 """
-function calc_sigma_lossfact(G_eq::T, radius_in::T, radius_ext::T) where {T<:REALTYPES}
+function calc_sigma_lossfact(G_eq::T, radius_in::T, radius_ext::T) where {T<:REALSCALAR}
     return G_eq * log(radius_ext / radius_in) / (2 * pi)
 end
 

src/DataModel/cabledesign.jl

@@ -321,7 +321,7 @@ $(FUNCTIONNAME)(design, component)
 - [`CableDesign`](@ref)
 - [`CableComponent`](@ref)
 """
-function add!(
+function LineCableModels.add!(
     design::CableDesign,
     component::CableComponent,
 )
@@ -368,7 +368,7 @@ $(FUNCTIONNAME)(design, "shield", conductor_group, insulator_group)
 - [`CableDesign`](@ref)
 - [`CableComponent`](@ref)
 """
-function add!(
+function LineCableModels.add!(
     design::CableDesign,
     component_id::String,
     conductor_group::ConductorGroup,
@@ -378,5 +378,5 @@ function add!(
     component = CableComponent(component_id, conductor_group, insulator_group)
 
     # Call the main function
-    return add!(design, component)
+    return LineCableModels.add!(design, component)
 end

src/DataModel/cableslibrary.jl

@@ -45,13 +45,13 @@ mutable struct CablesLibrary
 end
 
 # Implement the AbstractDict interface
-length(lib::CablesLibrary) = length(lib.data)
-setindex!(lib::CablesLibrary, value::CableDesign, key::String) = (lib.data[key] = value)
-iterate(lib::CablesLibrary, state...) = iterate(lib.data, state...)
-keys(lib::CablesLibrary) = keys(lib.data)
-values(lib::CablesLibrary) = values(lib.data)
-haskey(lib::CablesLibrary, key::String) = haskey(lib.data, key)
-getindex(lib::CablesLibrary, key::String) = getindex(lib.data, key)
+Base.length(lib::CablesLibrary) = length(lib.data)
+Base.setindex!(lib::CablesLibrary, value::CableDesign, key::String) = (lib.data[key] = value)
+Base.iterate(lib::CablesLibrary, state...) = iterate(lib.data, state...)
+Base.keys(lib::CablesLibrary) = keys(lib.data)
+Base.values(lib::CablesLibrary) = values(lib.data)
+Base.haskey(lib::CablesLibrary, key::String) = haskey(lib.data, key)
+Base.getindex(lib::CablesLibrary, key::String) = getindex(lib.data, key)
 
 """
 Stores a cable design in a [`CablesLibrary`](@ref) object.
@@ -78,7 +78,7 @@ println(library) # Prints the updated dictionary containing the new cable design
 - [`CableDesign`](@ref)
 - [`delete!`](@ref)
 """
-function add!(library::CablesLibrary, design::CableDesign)
+function LineCableModels.add!(library::CablesLibrary, design::CableDesign)
     library.data[design.cable_id] = design
     @info "Cable design with ID `$(design.cable_id)` added to the library."
     library
@@ -115,7 +115,7 @@ haskey(library, "example")  # Returns false
 - [`CablesLibrary`](@ref)
 - [`add!`](@ref)
 """
-function delete!(library::CablesLibrary, cable_id::String)
+function LineCableModels.delete!(library::CablesLibrary, cable_id::String)
     if haskey(library, cable_id)
         delete!(library.data, cable_id)
         @info "Cable design with ID `$cable_id` removed from the library."
@@ -162,12 +162,12 @@ println(missing_design === nothing)  # Prints true
 - [`add!`](@ref)
 - [`delete!`](@ref)
 """
-function get(library::CablesLibrary, cable_id::String, default=nothing)::Union{Nothing,CableDesign}
+function Base.get(library::CablesLibrary, cable_id::String, default=nothing)::Union{Nothing,CableDesign}
     if haskey(library, cable_id)
         @info "Cable design with ID `$cable_id` loaded from the library."
         return library[cable_id]
     else
-        @error "Cable design with ID `$cable_id` not found in the library."
-        throw(KeyError(cable_id))
+        @warn "Cable design with ID `$cable_id` not found in the library."
+        return default
     end
 end

src/DataModel/conductors.jl

@@ -221,7 +221,7 @@ $(FUNCTIONNAME)(conductor, WireArray, 0.02, 0.002, 7, 15, material_props, temper
 - [`calc_parallel_equivalent`](@ref)
 - [`calc_equivalent_alpha`](@ref)
 """
-function add!(
+function LineCableModels.add!(
     group::ConductorGroup,
     part_type::Type{T},  # The type of conductor part (WireArray, Strip, Tubular)
     args...;  # Arguments specific to the part type

src/DataModel/dataframe.jl

@@ -34,7 +34,7 @@ first(df, 5)  # Show the first 5 rows of the DataFrame
 - [`CableDesign`](@ref)
 - [`add!`](@ref)
 """
-function DataFrame(library::CablesLibrary)::DataFrame
+function DataFrames.DataFrame(library::CablesLibrary)::DataFrame
     ids = keys(library)
     nominal_data = [string(design.nominal_data) for design in values(library)]
     components = [
@@ -83,7 +83,7 @@ println(df)
 - [`LineCableSystem`](@ref)
 - [`CablePosition`](@ref)
 """
-function DataFrame(system::LineCableSystem)::DataFrame
+function DataFrames.DataFrame(system::LineCableSystem)::DataFrame
     cable_ids = String[]
     horz_coords = Number[]
     vert_coords = Number[]
@@ -152,7 +152,7 @@ core_data = DataFrame(design, :baseparams, S=0.5, rho_e=150)
 - [`calc_inductance_trifoil`](@ref)
 - [`calc_shunt_capacitance`](@ref)
 """
-function DataFrame(
+function DataFrames.DataFrame(
     design::CableDesign,
     format::Symbol=:baseparams;
     S::Union{Nothing,Number}=nothing,

src/DataModel/insulators.jl

@@ -156,7 +156,7 @@ $(FUNCTIONNAME)(insulator_group, Semicon, 0.015, 0.018, material_props)
 - [`Semicon`](@ref)
 - [`calc_parallel_equivalent`](@ref)
 """
-function add!(
+function LineCableModels.add!(
     group::InsulatorGroup,
     part_type::Type{T},  # The type of insulator part (Insulator, Semicon)
     args...;  # Arguments specific to the part type

src/DataModel/linecablesystem.jl

@@ -205,7 +205,7 @@ println(cable_system.num_cables)  # Prints: 2
 - [`CablePosition`](@ref)
 - [`CableDesign`](@ref)
 """
-function add!(
+function LineCableModels.add!(
     system::LineCableSystem,
     cable::CableDesign,
     horz::Number,

src/DataModel/preview.jl

@@ -187,7 +187,7 @@ cable_plot = $(FUNCTIONNAME)(design)  # Cable cross-section is displayed
 - [`Strip`](@ref)
 - [`Semicon`](@ref)
 """
-function preview(
+function LineCableModels.preview(
     design::CableDesign;
     x_offset=0.0,
     y_offset=0.0,
@@ -373,7 +373,7 @@ $(FUNCTIONNAME)(system, earth_model=earth_params, zoom_factor=0.5)
 - [`EarthModel`](@ref)
 - [`CablePosition`](@ref)
 """
-function preview(
+function LineCableModels.preview(
     system::LineCableSystem;
     earth_model=nothing,
     zoom_factor=0.25,
@@ -437,7 +437,7 @@ function preview(
     for cable_position in system.cables
         x_offset = to_nominal(cable_position.horz)
         y_offset = to_nominal(cable_position.vert)
-        preview(
+        LineCableModels.preview(
             cable_position.design_data;  # Changed from cable_position.design_data
             x_offset,
             y_offset,
@@ -481,8 +481,8 @@ for interactive use when no backend is explicitly specified. This is particularl
 # Examples
 
 ```julia
-choose_proper_backend()           # Auto-selects based on environment
-choose_proper_backend(pyplot)     # Explicitly use PyPlot backend
+_resolve_backend()           # Auto-selects based on environment
+_resolve_backend(pyplot)     # Explicitly use PyPlot backend
 ```
 """
 function _resolve_backend(backend=nothing)