Make pdflatex optional (#114)

* add param use_tex to plotting functions

* define USE_TEX in rectangular_wing.jl and use it

* All examples with USE_TEX=false now

* improve doc strings

Author: ufechner7

examples/ram_air_kite.jl

@@ -11,6 +11,7 @@ using CSV
 using DataFrames
 
 PLOT = true
+USE_TEX = false
 DEFORM = false
 
 # Create wing geometry
@@ -52,7 +53,8 @@ PLOT && plot_geometry(
     is_save=false,
     is_show=true,
     view_elevation=15,
-    view_azimuth=-120
+    view_azimuth=-120,
+    use_tex=USE_TEX
 )
 
 # Solving and plotting distributions
@@ -68,7 +70,8 @@ PLOT && plot_distribution(
     title="CAD_spanwise_distributions_alpha_$(round(aoa, digits=1))_beta_$(round(side_slip, digits=1))_yaw_$(round(yaw_rate, digits=1))_v_a_$(round(v_a, digits=1))",
     data_type=".pdf",
     is_save=false,
-    is_show=true
+    is_show=true,
+    use_tex=USE_TEX
 )
 
 PLOT && plot_polars(
@@ -85,6 +88,7 @@ PLOT && plot_polars(
     title="ram_kite_panels_$(wing.n_panels)_distribution_$(wing.spanwise_panel_distribution)",
     data_type=".pdf",
     is_save=false,
-    is_show=true
+    is_show=true,
+    use_tex=USE_TEX
 )
 nothing

examples/rectangular_wing.jl

@@ -3,6 +3,7 @@ using ControlPlots
 using VortexStepMethod
 
 PLOT = true
+USE_TEX = false
 
 # Step 1: Define wing parameters
 n_panels = 20          # Number of panels
@@ -60,6 +61,7 @@ PLOT && plot_geometry(
       save_path=".",
       is_save=false,
       is_show=true,
+      use_tex=USE_TEX
 )
 
 # Step 7: Plot spanwise distributions
@@ -69,7 +71,8 @@ PLOT && plot_distribution(
     [y_coordinates, y_coordinates],
     [results_vsm, results_llt],
     ["VSM", "LLT"],
-    title="Spanwise Distributions"
+    title="Spanwise Distributions",
+    use_tex=USE_TEX
 )
 
 # Step 8: Plot polar curves
@@ -81,6 +84,7 @@ PLOT && plot_polars(
     angle_range,
     angle_type="angle_of_attack",
     v_a,
-    title="Rectangular Wing Polars"
+    title="Rectangular Wing Polars",
+    use_tex=USE_TEX
 )
 nothing

examples/stall_model.jl

@@ -10,6 +10,7 @@ using CSV
 using DataFrames
 
 PLOT = true
+USE_TEX = false
 
 # Find root directory
 root_dir = dirname(@__DIR__)
@@ -75,7 +76,8 @@ PLOT && plot_geometry(
     is_save=false,
     is_show=true,
     view_elevation=15,
-    view_azimuth=-120
+    view_azimuth=-120,
+    use_tex=USE_TEX
 )
 
 # Solving and plotting distributions
@@ -93,7 +95,8 @@ PLOT && plot_distribution(
     data_type=".pdf",
     save_path=joinpath(save_folder, "spanwise_distributions"),
     is_save=false,
-    is_show=true
+    is_show=true,
+    use_tex=USE_TEX
 )
 
 # Plotting polar
@@ -124,6 +127,7 @@ PLOT && plot_polars(
     data_type=".pdf",
     save_path=joinpath(save_folder, "polars"),
     is_save=true,
-    is_show=true
+    is_show=true,
+    use_tex=USE_TEX
 )
 nothing

src/plotting.jl

@@ -6,7 +6,7 @@ Set the default style for plots using LaTeX.
 ``
 # Arguments:
 - `titel_size`: size of the plot title in points (default: 16)
-- `use_tex`: if a separately installed LaTeX version shall be used
+- `ùse_tex`: if the external `pdflatex` command shall be used
 """
 function set_plot_style(titel_size=16; use_tex=false)
     rcParams = plt.PyDict(plt.matplotlib."rcParams")
@@ -148,7 +148,8 @@ function set_axes_equal!(ax; zoom=1.8)
 end
 
 """
-    create_geometry_plot(body_aero::BodyAerodynamics, title, view_elevation, view_azimuth; zoom=1.8)
+    create_geometry_plot(body_aero::BodyAerodynamics, title, view_elevation, view_azimuth; 
+                         zoom=1.8, use_tex=false)
 
 Create a 3D plot of wing geometry including panels and filaments.
 
@@ -162,8 +163,8 @@ Create a 3D plot of wing geometry including panels and filaments.
 - zoom: zoom factor (default: 1.8)
 """
 function create_geometry_plot(body_aero::BodyAerodynamics, title, view_elevation, view_azimuth; 
-                              zoom=1.8)
-    set_plot_style(28)
+                              zoom=1.8, use_tex=false)
+    set_plot_style(28; use_tex)
 
     panels = body_aero.panels
     va = isa(body_aero.va, Tuple) ? body_aero.va[1] : body_aero.va
@@ -249,7 +250,7 @@ end
     plot_geometry(body_aero::BodyAerodynamics, title; 
                   data_type=".pdf", save_path=nothing, 
                   is_save=false, is_show=false, 
-                  view_elevation=15, view_azimuth=-120)
+                  view_elevation=15, view_azimuth=-120, use_tex=false)
 
 Plot wing geometry from different viewpoints and optionally save/show plots.
 
@@ -264,6 +265,7 @@ Plot wing geometry from different viewpoints and optionally save/show plots.
 - `is_show`: boolean value, indicates if the graphic shall be displayed (default: `false`)
 - `view_elevation`: initial view elevation angle (default: 15) [°]
 - `view_azimuth`: initial view azimuth angle (default: -120) [°]
+- `use_tex`: if the external `pdflatex` command shall be used (default: false)
 
 """
 function VortexStepMethod.plot_geometry(body_aero::BodyAerodynamics, title;
@@ -272,41 +274,42 @@ function VortexStepMethod.plot_geometry(body_aero::BodyAerodynamics, title;
     is_save=false,
     is_show=false,
     view_elevation=15,
-    view_azimuth=-120)
+    view_azimuth=-120,
+    use_tex=false)
 
     if is_save
         plt.ioff()
         # Angled view
-        fig = create_geometry_plot(body_aero, "$(title)_angled_view", 15, -120)
+        fig = create_geometry_plot(body_aero, "$(title)_angled_view", 15, -120; use_tex)
         save_plot(fig, save_path, "$(title)_angled_view", data_type=data_type)
 
         # Top view
-        fig = create_geometry_plot(body_aero, "$(title)_top_view", 90, 0)
+        fig = create_geometry_plot(body_aero, "$(title)_top_view", 90, 0; use_tex)
         save_plot(fig, save_path, "$(title)_top_view", data_type=data_type)
 
         # Front view
-        fig = create_geometry_plot(body_aero, "$(title)_front_view", 0, 0)
+        fig = create_geometry_plot(body_aero, "$(title)_front_view", 0, 0; use_tex)
         save_plot(fig, save_path, "$(title)_front_view", data_type=data_type)
 
         # Side view
-        fig = create_geometry_plot(body_aero, "$(title)_side_view", 0, -90)
+        fig = create_geometry_plot(body_aero, "$(title)_side_view", 0, -90; use_tex)
         save_plot(fig, save_path, "$(title)_side_view", data_type=data_type)
     end
 
     if is_show
         plt.ion()
-        fig = create_geometry_plot(body_aero, title, view_elevation, view_azimuth)
+        fig = create_geometry_plot(body_aero, title, view_elevation, view_azimuth; use_tex)
         plt.display(fig)
     else
-        fig = create_geometry_plot(body_aero, title, view_elevation, view_azimuth)
+        fig = create_geometry_plot(body_aero, title, view_elevation, view_azimuth; use_tex)
     end
     fig
 end
 
 """
     plot_distribution(y_coordinates_list, results_list, label_list;  
                       title="spanwise_distribution", data_type=".pdf",
-                      save_path=nothing, is_save=false, is_show=true)
+                      save_path=nothing, is_save=false, is_show=true, use_tex=false)
 
 Plot spanwise distributions of aerodynamic properties.
 
@@ -321,20 +324,22 @@ Plot spanwise distributions of aerodynamic properties.
 - `save_path`: Path to save plots (default: nothing)
 - `is_save`: Whether to save plots (default: false)
 - `is_show`: Whether to display plots (default: true)
+- `use_tex`: if the external `pdflatex` command shall be used
 """
 function VortexStepMethod.plot_distribution(y_coordinates_list, results_list, label_list;
     title="spanwise_distribution",
     data_type=".pdf",
     save_path=nothing,
     is_save=false,
-    is_show=true)
+    is_show=true,
+    use_tex=false)
 
     length(results_list) == length(label_list) || throw(ArgumentError(
         "Number of results ($(length(results_list))) must match number of labels ($(length(label_list)))"
     ))
 
     # Set the plot style
-    set_plot_style()
+    set_plot_style(; use_tex)
 
     # Initializing plot
     fig, axs = plt.subplots(3, 3, figsize=(16, 10))
@@ -474,7 +479,7 @@ end
 """
     generate_polar_data(solver, body_aero::BodyAerodynamics, angle_range;     
                         angle_type="angle_of_attack", angle_of_attack=0.0,
-                        side_slip=0.0, v_a=10.0)
+                        side_slip=0.0, v_a=10.0, use_latex=false)
 
 Generate polar data for aerodynamic analysis over a range of angles.
 
@@ -499,7 +504,8 @@ function generate_polar_data(
     angle_type="angle_of_attack",
     angle_of_attack=0.0,
     side_slip=0.0,
-    v_a=10.0
+    v_a=10.0,
+    use_latex=false
 )
     n_panels = length(body_aero.panels)
     n_angles = length(angle_range)
@@ -517,8 +523,6 @@ function generate_polar_data(
     # Previous gamma for initialization
     gamma = nothing
 
-    set_plot_style()
-
     for (i, angle_i) in enumerate(angle_range)
         # Set angle based on type
         if angle_type == "angle_of_attack"
@@ -578,7 +582,7 @@ end
                 angle_range=range(0, 20, 2), angle_type="angle_of_attack", 
                 angle_of_attack=0.0, side_slip=0.0, v_a=10.0, 
                 title="polar", data_type=".pdf", save_path=nothing, 
-                is_save=true, is_show=true)
+                is_save=true, is_show=true, use_tex=false)
 
 Plot polar data comparing different solvers and configurations.
 
@@ -599,6 +603,7 @@ Plot polar data comparing different solvers and configurations.
 - `save_path`: Path to save plots (default: nothing)
 - `is_save`: Whether to save plots (default: true)
 - `is_show`: Whether to display plots (default: true)
+- `use_tex`: if the external `pdflatex` command shall be used (default: false)
 """
 function VortexStepMethod.plot_polars(
     solver_list,
@@ -614,7 +619,8 @@ function VortexStepMethod.plot_polars(
     data_type=".pdf",
     save_path=nothing,
     is_save=true,
-    is_show=true
+    is_show=true,
+    use_tex=false
 )
     # Validate inputs
     total_cases = length(body_aero_list) + length(literature_path_list)
@@ -623,6 +629,7 @@ function VortexStepMethod.plot_polars(
                             "cases ($total_cases), and labels ($(length(label_list)))"))
     end
     main_title = replace(title, " " => "_")
+    set_plot_style(; use_tex)
 
     # Generate polar data
     polar_data_list = []