chore(examples): remove unused example files and clean up project structure

Author: amaurigmartins

.gitignore

@@ -27,6 +27,7 @@ Manifest.toml
 
 # the hidden folder of shame
 temp/
+local/
 
 # Internal files
 dev

examples/18kV_1000mm2_trifoil_export.pscx

@@ -108,7 +108,7 @@
         "alpha": 0.004,
         "__julia_type__": "LineCableModels.Materials.Material",
         "eps_r": 1,
-        "mu_r": 1,
+        "mu_r": 0.999983,
         "rho": 2.14e-7
     },
     "copper_corrected": {

examples/525kV_1600mm2_bipole_export.pscx

@@ -31,86 +31,81 @@ materials with their standard properties.
 materials_db = MaterialsLibrary()
 
 # Inspect the contents of the materials library:
-df_initial = list_materialslibrary(materials_db)
+df_initial = DataFrame(materials_db)
 
 #=
-The function [`list_materialslibrary`](@ref) returns a `DataFrame` with all materials and their properties, namely: electrical resistivity, relative permittivity, relative permeability, reference temperature, and temperature coefficient.
+The function [`DataFrame`](@ref) returns a `DataFrame` with all materials and their properties, namely: electrical resistivity, relative permittivity, relative permeability, reference temperature, and temperature coefficient.
 =#
 
 # ##   Adding new materials
 #=
 !!! note "Note"
-	New materials can be added to the library using the [`Material`](@ref) constructor followed by [`store_materialslibrary!`](@ref).
+	New materials can be added to the library using the [`Material`](@ref) constructor followed by [`add!`](@ref).
 
 It might be useful to add other conductor materials with corrected properties based on recognized standards [cigre531](@cite) [IEC60287](@cite).
 =#
 
 copper_corrected = Material(1.835e-8, 1.0, 0.999994, 20.0, 0.00393) # Copper with corrected resistivity from IEC 60287-3-2
-store_materialslibrary!(materials_db, "copper_corrected", copper_corrected)
+add!(materials_db, "copper_corrected", copper_corrected)
 aluminum_corrected = Material(3.03e-8, 1.0, 0.999994, 20.0, 0.00403) # Aluminum with corrected resistivity from IEC 60287-3-2
-store_materialslibrary!(materials_db, "aluminum_corrected", aluminum_corrected)
+add!(materials_db, "aluminum_corrected", aluminum_corrected)
 lead = Material(21.4e-8, 1.0, 0.999983, 20.0, 0.00400) # Lead or lead alloy
-store_materialslibrary!(materials_db, "lead", lead)
+add!(materials_db, "lead", lead)
 steel = Material(13.8e-8, 1.0, 300.0, 20.0, 0.00450) # Steel
-store_materialslibrary!(materials_db, "steel", steel)
+add!(materials_db, "steel", steel)
 bronze = Material(3.5e-8, 1.0, 1.0, 20.0, 0.00300) # Bronze
-store_materialslibrary!(materials_db, "bronze", bronze)
+add!(materials_db, "bronze", bronze)
 stainless_steel = Material(70.0e-8, 1.0, 500.0, 20.0, 0.0) # Stainless steel
-store_materialslibrary!(materials_db, "stainless_steel", stainless_steel)
+add!(materials_db, "stainless_steel", stainless_steel)
 
 #=
 When modeling cables for EMT analysis, one might be concerned with the impact of insulators and semiconductive layers on cable constants. Common insulation materials and semicons with different dielectric properties are reported in Table 6 of [cigre531](@cite). Let us include some of these materials in the [`MaterialsLibrary`](@ref) to help our future selves.
 =#
 
 epr = Material(1e15, 3.0, 1.0, 20.0, 0.005) # EPR (ethylene propylene rubber)
-store_materialslibrary!(materials_db, "epr", epr)
+add!(materials_db, "epr", epr)
 pvc = Material(1e15, 8.0, 1.0, 20.0, 0.1) # PVC (polyvinyl chloride)
-store_materialslibrary!(materials_db, "pvc", pvc)
+add!(materials_db, "pvc", pvc)
 laminated_paper = Material(1e15, 2.8, 1.0, 20.0, 0.0) # Laminated paper propylene
-store_materialslibrary!(materials_db, "laminated_paper", laminated_paper)
+add!(materials_db, "laminated_paper", laminated_paper)
 carbon_pe = Material(0.06, 1e3, 1.0, 20.0, 0.0) # Carbon-polyethylene compound (semicon)
-store_materialslibrary!(materials_db, "carbon_pe", carbon_pe)
+add!(materials_db, "carbon_pe", carbon_pe)
 conductive_paper = Material(18.5, 8.6, 1.0, 20.0, 0.0) # Conductive paper layer (semicon)
-store_materialslibrary!(materials_db, "conductive_paper", conductive_paper)
+add!(materials_db, "conductive_paper", conductive_paper)
 
 # ##  Removing materials
 #=
 !!! note "Note"
-	Materials can be removed from the library with the [`remove_materialslibrary!`](@ref) function.
+	Materials can be removed from the library with the [`delete!`](@ref) function.
 =#
 
 # Add a duplicate material by accident:
-store_materialslibrary!(materials_db, "epr_dupe", epr)
+add!(materials_db, "epr_dupe", epr)
 
-# And now remove it using the [`remove_materialslibrary!`](@ref) function:
-remove_materialslibrary!(materials_db, "epr_dupe")
+# And now remove it using the [`delete!`](@ref) function:
+delete!(materials_db, "epr_dupe")
 
 # Examine the updated library after removing the duplicate:
 println("Material properties compiled from CIGRE TB-531 and IEC 60287:")
-df_final = list_materialslibrary(materials_db)
+df_final = DataFrame(materials_db)
 
 # ##  Saving the materials library to JSON
 output_file = joinpath(@__DIR__, "materials_library.json")
-save_materialslibrary(
-    materials_db,
-    file_name=output_file,
-);
+save(materials_db, file_name=output_file);
 
 
 # ##  Retrieving materials for use
 #=
 !!! note "Note"
-	To load from an existing JSON file, instantiate a new [`MaterialsLibrary`](@ref) followed by a call to the [`load_materialslibrary!`](@ref) method. Materials can be retrieved from the library using the [`get_material`](@ref) function.
+	To load from an existing JSON file, instantiate a new [`MaterialsLibrary`](@ref) followed by a call to the [`load!`](@ref) method. Materials can be retrieved from the library using the [`get`](@ref) function.
 =#
 
 # Initialize a new [`MaterialsLibrary`](@ref) and load from the JSON file:
 materials_from_json = MaterialsLibrary()
-load_materialslibrary!(
-    materials_from_json,
-    file_name=output_file,
-)
+load!(materials_from_json, file_name=output_file)
+
 # Retrieve a material and display the object:
-copper = get_material(materials_from_json, "copper_corrected")
+copper = get(materials_from_json, "copper_corrected")
 
 # Access the material properties:
 println("\nRetrieved copper_corrected material properties:")

examples/cables_library.json

@@ -39,12 +39,12 @@ using LineCableModels
 
 # Initialize materials library with default values:
 materials_db = MaterialsLibrary(add_defaults=true)
-list_materialslibrary(materials_db)
+DataFrame(materials_db)
 
 #=
 ```julia
 # Alternatively, it can be loaded from the example file built in the previous tutorial:
-load_materialslibrary!(
+load!(
 	materials_db,
 	file_name = "materials_library.json",
 )
@@ -191,19 +191,19 @@ The core consists of a 4-layer AAAC stranded conductor with 61 wires arranged in
 =#
 
 # Initialize the conductor object and assign the central wire:
-material = get_material(materials_db, "aluminum")
+material = get(materials_db, "aluminum")
 core = ConductorGroup(WireArray(0, Diameter(d_w), 1, 0, material))
 
 #=
 !!! tip "Convenience methods"
-	The [`addto_conductorgroup!`](@ref) method internally passes the `radius_ext` of the existing object to the `radius_in` argument of the new conductor. This enables easy stacking of multiple layers without redundancy. Moreover, the [`Diameter`](@ref) method is a convenience function that converts the diameter to radius at the constructor level. This maintains alignment with manufacturer specifications while enabling internal calculations to use radius values directly. This approach eliminates repetitive unit conversions and potential sources of implementation error.
+	The [`add!`](@ref) method internally passes the `radius_ext` of the existing object to the `radius_in` argument of the new conductor. This enables easy stacking of multiple layers without redundancy. Moreover, the [`Diameter`](@ref) method is a convenience function that converts the diameter to radius at the constructor level. This maintains alignment with manufacturer specifications while enabling internal calculations to use radius values directly. This approach eliminates repetitive unit conversions and potential sources of implementation error.
 =#
 
 # Add the subsequent layers of wires and inspect the object:
-addto_conductorgroup!(core, WireArray, Diameter(d_w), 6, 15, material)
-addto_conductorgroup!(core, WireArray, Diameter(d_w), 12, 13.5, material)
-addto_conductorgroup!(core, WireArray, Diameter(d_w), 18, 12.5, material)
-addto_conductorgroup!(core, WireArray, Diameter(d_w), 24, 11, material)
+add!(core, WireArray, Diameter(d_w), 6, 15, material)
+add!(core, WireArray, Diameter(d_w), 12, 13.5, material)
+add!(core, WireArray, Diameter(d_w), 18, 12.5, material)
+add!(core, WireArray, Diameter(d_w), 24, 11, material)
 
 #=
 ### Inner semiconductor
@@ -218,12 +218,12 @@ the conductor and insulation, eliminating air gaps and reducing field concentrat
 =#
 
 # Inner semiconductive tape:
-material = get_material(materials_db, "polyacrylate")
+material = get(materials_db, "polyacrylate")
 main_insu = InsulatorGroup(Semicon(core, Thickness(t_sct), material))
 
 # Inner semiconductor (1000 Ω.m as per IEC 840):
-material = get_material(materials_db, "semicon1")
-addto_insulatorgroup!(main_insu, Semicon, Thickness(t_sc_in), material)
+material = get(materials_db, "semicon1")
+add!(main_insu, Semicon, Thickness(t_sc_in), material)
 
 #=
 ### Main insulation
@@ -233,8 +233,8 @@ medium and high voltage cables due to its excellent dielectric properties.
 =#
 
 # Add the insulation layer:
-material = get_material(materials_db, "pe")
-addto_insulatorgroup!(main_insu, Insulator, Thickness(t_ins), material)
+material = get(materials_db, "pe")
+add!(main_insu, Insulator, Thickness(t_ins), material)
 
 #=
 ### Outer semiconductor
@@ -244,12 +244,12 @@ transition from insulation to the metallic screen.
 =#
 
 # Outer semiconductor (500 Ω.m as per IEC 840):
-material = get_material(materials_db, "semicon2")
-addto_insulatorgroup!(main_insu, Semicon, Thickness(t_sc_out), material)
+material = get(materials_db, "semicon2")
+add!(main_insu, Semicon, Thickness(t_sc_out), material)
 
 # Outer semiconductive tape:
-material = get_material(materials_db, "polyacrylate")
-addto_insulatorgroup!(main_insu, Semicon, Thickness(t_sct), material)
+material = get(materials_db, "polyacrylate")
+add!(main_insu, Semicon, Thickness(t_sct), material)
 
 # Group core-related components:
 core_cc = CableComponent("core", core, main_insu)
@@ -273,7 +273,7 @@ datasheet_info = NominalData(
 cable_design = CableDesign(cable_id, core_cc, nominal_data=datasheet_info)
 
 # At this point, it becomes possible to preview the cable design:
-plt1 = preview_cabledesign(cable_design)
+plt1 = preview(cable_design)
 
 #=
 ### Wire screens
@@ -287,23 +287,23 @@ The metallic screen (typically copper) serves multiple purposes:
 
 # Build the wire screens on top of the previous layer:
 lay_ratio = 10 # typical value for wire screens
-material = get_material(materials_db, "copper")
+material = get(materials_db, "copper")
 screen_con =
     ConductorGroup(WireArray(main_insu, Diameter(d_ws), num_sc_wires, lay_ratio, material))
 
 # Add the equalizing copper tape wrapping the wire screen:
-addto_conductorgroup!(screen_con, Strip, Thickness(t_cut), w_cut, lay_ratio, material)
+add!(screen_con, Strip, Thickness(t_cut), w_cut, lay_ratio, material)
 
 # Water blocking tape over screen:
-material = get_material(materials_db, "polyacrylate")
+material = get(materials_db, "polyacrylate")
 screen_insu = InsulatorGroup(Semicon(screen_con, Thickness(t_wbt), material))
 
 # Group sheath components and assign to design:
 sheath_cc = CableComponent("sheath", screen_con, screen_insu)
-addto_cabledesign!(cable_design, sheath_cc)
+add!(cable_design, sheath_cc)
 
 # Examine the newly added components:
-plt2 = preview_cabledesign(cable_design)
+plt2 = preview(cable_design)
 
 #=
 ### Outer jacket components
@@ -313,27 +313,27 @@ and PE (polyethylene) outer jacket for mechanical protection.
 =#
 
 # Add the aluminum foil (moisture barrier):
-material = get_material(materials_db, "aluminum")
+material = get(materials_db, "aluminum")
 jacket_con = ConductorGroup(Tubular(screen_insu, Thickness(t_alt), material))
 
 # PE layer after aluminum foil:
-material = get_material(materials_db, "pe")
+material = get(materials_db, "pe")
 jacket_insu = InsulatorGroup(Insulator(jacket_con, Thickness(t_pet), material))
 
 # PE jacket (outer mechanical protection):
-material = get_material(materials_db, "pe")
-addto_insulatorgroup!(jacket_insu, Insulator, Thickness(t_jac), material)
+material = get(materials_db, "pe")
+add!(jacket_insu, Insulator, Thickness(t_jac), material)
 
 #=
 !!! tip "Convenience methods"
-	To facilitate data entry, it is possible to call the [`addto_cabledesign!`](@ref) method directly on the [`ConductorGroup`](@ref) and [`InsulatorGroup`](@ref) constituents of the component to include, without instantiating the [`CableComponent`](@ref) first.
+	To facilitate data entry, it is possible to call the [`add!`](@ref) method directly on the [`ConductorGroup`](@ref) and [`InsulatorGroup`](@ref) constituents of the component to include, without instantiating the [`CableComponent`](@ref) first.
 =#
 
 # Assign the jacket parts directly to the design:
-addto_cabledesign!(cable_design, "jacket", jacket_con, jacket_insu)
+add!(cable_design, "jacket", jacket_con, jacket_insu)
 
 # Inspect the finished cable design:
-plt3 = preview_cabledesign(cable_design)
+plt3 = preview(cable_design)
 
 #=
 ## Examining the cable parameters (RLC)
@@ -342,29 +342,29 @@ In this section, the cable design is examined and the calculated parameters are
 =#
 
 # Compare with datasheet information (R, L, C values):
-core_df = to_df(cable_design, :baseparams)
+core_df = DataFrame(cable_design, :baseparams)
 
 # Obtain the equivalent electromagnetic properties of the cable:
-components_df = to_df(cable_design, :components)
+components_df = DataFrame(cable_design, :components)
 
 # Get detailed description of all cable parts:
-detailed_df = to_df(cable_design, :detailed)
+detailed_df = DataFrame(cable_design, :detailed)
 
 #=
 ## Saving the cable design
 
 !!! note "Cables library"
-	Designs can be saved to a library for future use. The [`CablesLibrary`](@ref) is a container for storing multiple cable designs, allowing for easy access and reuse in different projects.  Library management is performed using the [`list_cableslibrary`](@ref), [`store_cableslibrary!`](@ref), and [`save_cableslibrary`](@ref) functions.
+	Designs can be saved to a library for future use. The [`CablesLibrary`](@ref) is a container for storing multiple cable designs, allowing for easy access and reuse in different projects.  Library management is performed using the [`DataFrame`](@ref), [`add!`](@ref), and [`save`](@ref) functions.
 =#
 
 # Store the cable design and inspect the library contents:
 library = CablesLibrary()
-store_cableslibrary!(library, cable_design)
-list_cableslibrary(library)
+add!(library, cable_design)
+DataFrame(library)
 
 # Save to file for later use:
 output_file = joinpath(@__DIR__, "cables_library.json")
-save_cableslibrary(library, file_name=output_file);
+save(library, file_name=output_file);
 
 
 #=
@@ -385,7 +385,7 @@ f = 10.0 .^ range(0, stop=6, length=10)  # Frequency range
 earth_params = EarthModel(f, 100.0, 10.0, 1.0)  # 100 Ω·m resistivity, εr=10, μr=1
 
 # Earth model base (DC) properties:
-earthmodel_df = to_df(earth_params)
+earthmodel_df = DataFrame(earth_params)
 
 #=
 ### Three-phase system in trifoil configuration
@@ -400,21 +400,22 @@ y0 = -1
 xa, ya, xb, yb, xc, yc = trifoil_formation(x0, y0, 0.035)
 
 # Initialize the `LineCableSystem` with the first cable (phase A):
-cablepos = CablePosition(cable_design, xa, ya, Dict("core" => 1, "sheath" => 0, "jacket" => 0))
+cablepos = CablePosition(cable_design, xa, ya,
+    Dict("core" => 1, "sheath" => 0, "jacket" => 0))
 cable_system = LineCableSystem("18kV_1000mm2_trifoil", 1000.0, cablepos)
 
 # Add remaining cables (phases B and C):
-addto_linecablesystem!(cable_system, cable_design, xb, yb,
+add!(cable_system, cable_design, xb, yb,
     Dict("core" => 2, "sheath" => 0, "jacket" => 0),
 )
-addto_linecablesystem!(
+add!(
     cable_system, cable_design, xc, yc,
     Dict("core" => 3, "sheath" => 0, "jacket" => 0),
 )
 
 #=
 !!! note "Phase mapping"
-	The [`addto_linecablesystem!`](@ref) function allows the specification of phase mapping for each cable. The `Dict` argument maps the cable components to their respective phases, where `core` is the conductor, `sheath` is the screen, and `jacket` is the outer jacket. The values (1, 2, 3) represent the phase numbers (A, B, C) in this case. Components mapped to phase 0 will be Kron-eliminated (grounded). Components set to the same phase will be bundled into an equivalent phase.
+	The [`add!`](@ref) function allows the specification of phase mapping for each cable. The `Dict` argument maps the cable components to their respective phases, where `core` is the conductor, `sheath` is the screen, and `jacket` is the outer jacket. The values (1, 2, 3) represent the phase numbers (A, B, C) in this case. Components mapped to phase 0 will be Kron-eliminated (grounded). Components set to the same phase will be bundled into an equivalent phase.
 =#
 
 #=
@@ -424,10 +425,10 @@ In this section the complete three-phase cable system is examined.
 =#
 
 # Display system details:
-system_df = to_df(cable_system)
+system_df = DataFrame(cable_system)
 
 # Visualize the cross-section of the three-phase system:
-plt4 = preview_linecablesystem(cable_system, zoom_factor=0.15)
+plt4 = preview(cable_system, zoom_factor=0.15)
 
 #=
 ## PSCAD export
@@ -437,7 +438,7 @@ The final step showcases how to export the model for electromagnetic transient s
 
 # Export to PSCAD input file:
 output_file = joinpath(@__DIR__, "$(cable_system.system_id)_export.pscx")
-export_file = export_pscad_lcp(cable_system, earth_params, file_name=output_file);
+export_file = export_data(:pscad, cable_system, earth_params, file_name=output_file);
 
 #=
 ## Conclusion