Merge pull request #15613 from rmcdermo/master

Python: McCaffrey updates; better handling of ticks; fix revision string

Author: rmcdermo

Utilities/Python/fdsplotlib.py

@@ -528,8 +528,8 @@ def read_csv_cached(path, **kwargs):
             f = plot_to_fig(
                 x_data=y_i if flip_axis else x_i,
                 y_data=x_i if flip_axis else y_i,
-                revision_label=version_string,
-                figure_handle=f,                  # keep same figure
+                revision_label=version_string if dtest else None,
+                figure_handle=f,
                 data_label=d2_key_labels[i],
                 line_style=d2_styles[i],
             )
@@ -857,14 +857,6 @@ def plot_to_fig(x_data,y_data,**kwargs):
     if linestyle == '-.': dashes = kwargs.get('line_dashes',(6, 3, 1, 3))
     if linestyle == ':': dashes = kwargs.get('line_dashes',(1, 3))
 
-    # This set is what we were using in Matlab
-    # if linestyle == '': dashes = (None, None); linewidth = 0;
-    # if linestyle == '-': dashes = (None, None)
-    # if linestyle == '--': dashes = kwargs.get('line_dashes',(10, 6.2))
-    # if linestyle == '-.': dashes = kwargs.get('line_dashes',(12, 7.4, 3, 7.4))
-    # if linestyle == ':': dashes = kwargs.get('line_dashes',(1, 3))
-
-
     data_label = kwargs.get('data_label',None)
 
     # trap any data_labels set to blank (old matlab convention)
@@ -1014,6 +1006,88 @@ def plot_to_fig(x_data,y_data,**kwargs):
                       fontsize=ax._legend_fontsize,
                       frameon=False)
 
+        # plot title
+        if kwargs.get('plot_title'):
+            if kwargs.get('title_fontsize'):
+                title_fontsize=kwargs.get('title_fontsize')
+            else:
+                title_fontsize=default_title_fontsize
+
+            plt.text(0.05, 0.95, kwargs.get('plot_title'),
+            transform=plt.gca().transAxes,
+            fontsize=title_fontsize,
+            verticalalignment='top',
+            horizontalalignment='left')
+
+        # set axes and tick properties
+        xmin=kwargs.get('x_min')
+        xmax=kwargs.get('x_max')
+        ymin=kwargs.get('y_min')
+        ymax=kwargs.get('y_max')
+
+        ax.set_xlim(xmin,xmax)
+        ax.set_ylim(ymin,ymax)
+
+        # ------------------------------------------------------------
+        # TICK HANDLING (clean, deterministic)
+        # ------------------------------------------------------------
+
+        scale_x = ax.get_xscale()
+        scale_y = ax.get_yscale()
+
+        # -------------------------------
+        # X-axis ticks
+        # -------------------------------
+        if xticks is not None:
+            # USER EXPLICIT OVERRIDE
+            ax.set_xticks(xticks)
+            ax.xaxis.set_major_formatter(ticker.FormatStrFormatter('%g'))
+
+        elif xnumticks is not None:
+            # USER requests a number of ticks
+            if scale_x == "log":
+                ax.set_xticks(np.logspace(np.log10(xmin), np.log10(xmax), xnumticks))
+            else:
+                ax.set_xticks(np.linspace(xmin, xmax, xnumticks))
+
+        else:
+            # DEFAULT behavior
+            if scale_x == "log":
+                ax.xaxis.set_major_locator(ticker.LogLocator(base=10))
+                ax.xaxis.set_major_formatter(ticker.LogFormatterSciNotation(base=10))
+            else:
+                ax.xaxis.set_major_locator(ticker.MaxNLocator(nbins=detault_nticks, min_n_ticks=4))
+                sf = ticker.ScalarFormatter(useMathText=True)
+                sf.set_powerlimits((-3, 4))
+                ax.xaxis.set_major_formatter(sf)
+
+        # -------------------------------
+        # Y-axis ticks
+        # -------------------------------
+        if yticks is not None:
+            # USER EXPLICIT OVERRIDE
+            ax.set_yticks(yticks)
+            ax.yaxis.set_major_formatter(ticker.FormatStrFormatter('%g'))
+
+        elif ynumticks is not None:
+            # USER requests a number of ticks
+            if scale_y == "log":
+                ax.set_yticks(np.logspace(np.log10(ymin), np.log10(ymax), ynumticks))
+            else:
+                ax.set_yticks(np.linspace(ymin, ymax, ynumticks))
+
+        else:
+            # DEFAULT behavior
+            if scale_y == "log":
+                ax.yaxis.set_major_locator(ticker.LogLocator(base=10))
+                ax.yaxis.set_major_formatter(ticker.LogFormatterSciNotation(base=10))
+            else:
+                ax.yaxis.set_major_locator(ticker.MaxNLocator(nbins=detault_nticks, min_n_ticks=4))
+                sf = ticker.ScalarFormatter(useMathText=True)
+                sf.set_powerlimits((-3, 4))
+                ax.yaxis.set_major_formatter(sf)
+
+
     # --- case 3: existing figure, adding more data ---
     else:
         loc = getattr(ax, '_legend_loc', 'best')
@@ -1028,72 +1102,6 @@ def plot_to_fig(x_data,y_data,**kwargs):
                       fontsize=fontsize,
                       framealpha=framealpha)
 
-
-    # plot title
-    if kwargs.get('plot_title'):
-        if kwargs.get('title_fontsize'):
-            title_fontsize=kwargs.get('title_fontsize')
-        else:
-            title_fontsize=default_title_fontsize
-
-        plt.text(0.05, 0.95, kwargs.get('plot_title'),
-        transform=plt.gca().transAxes,
-        fontsize=title_fontsize,
-        verticalalignment='top',
-        horizontalalignment='left')
-
-    # set axes and tick properties
-    xmin=kwargs.get('x_min')
-    xmax=kwargs.get('x_max')
-    ymin=kwargs.get('y_min')
-    ymax=kwargs.get('y_max')
-
-    ax.set_xlim(xmin,xmax)
-    ax.set_ylim(ymin,ymax)
-
-    # --- Tick handling AFTER limits are set ---
-    if ax.get_xscale() == 'linear':
-        # ----- LINEAR AXIS -----
-        if xticks is None and xnumticks is None:
-            ax.xaxis.set_major_locator(ticker.MaxNLocator(nbins=detault_nticks, min_n_ticks=4))
-            sf = ticker.ScalarFormatter(useMathText=True)
-            sf.set_powerlimits((-3, 4))
-            ax.xaxis.set_major_formatter(sf)
-
-    elif ax.get_xscale() == 'log':
-        # ----- LOG AXIS -----
-        # Do not touch scalar formatters – LogFormatter is correct.
-        ax.xaxis.set_major_locator(ticker.LogLocator(base=10))
-        ax.xaxis.set_major_formatter(ticker.LogFormatterSciNotation(base=10))
-
-    # Same for y-axis
-    if ax.get_yscale() == 'linear':
-        if yticks is None and ynumticks is None:
-            ax.yaxis.set_major_locator(ticker.MaxNLocator(nbins=detault_nticks, min_n_ticks=4))
-            sf = ticker.ScalarFormatter(useMathText=True)
-            sf.set_powerlimits((-3, 4))
-            ax.yaxis.set_major_formatter(sf)
-
-    elif ax.get_yscale() == 'log':
-        ax.yaxis.set_major_locator(ticker.LogLocator(base=10))
-        ax.yaxis.set_major_formatter(ticker.LogFormatterSciNotation(base=10))
-
-    # set number of ticks if requested by the user
-    if xnumticks is not None:
-        if plot_type in ('loglog', 'semilogx'):
-            ax.set_xticks(np.logspace(xmin, xmax, xnumticks))
-        else:
-            ax.set_xticks(np.linspace(xmin, xmax, xnumticks))
-    if ynumticks is not None:
-        if plot_type in ('loglog', 'semilogy'):
-            ax.set_yticks(np.logspace(ymin, ymax, ynumticks))
-        else:
-            ax.set_yticks(np.linspace(ymin, ymax, ynumticks))
-
-    # set ticks if requested by the user
-    if xticks is not None: ax.set_xticks(xticks)
-    if yticks is not None: ax.set_yticks(yticks)
-
     if kwargs.get('revision_label'):
         add_version_string(ax=ax, version_str=kwargs.get('revision_label'), plot_type=plot_type, font_size=version_fontsize)
 

Utilities/Python/scripts/McCaffrey_Plume.py

@@ -160,7 +160,8 @@
                                    y_label=r'$V/Q^{1/5}$ $({\rm m s}^{-1} \; {\rm kW}^{-1/5})$',
                                    plot_title=f'McCaffrey Centerline Velocity, {res}',
                                    legend_location='lower right',
-                                   plot_type='loglog')
+                                   plot_type='loglog',
+                                   yticks = [0.6, 1, 2, 3])
 
     for i, c in enumerate(chid):
         fname = os.path.join(datadir, f'{c}_line.csv')
@@ -175,7 +176,7 @@
                 v = M.iloc[:, 1].values
             zq_fds = z / (Q[i]**(2.0/5.0))
             vq_fds = v / (Q[i]**(1.0/5.0))
-            fdsplotlib.plot_to_fig(x_data=zq_fds, y_data=vq_fds, 
+            fdsplotlib.plot_to_fig(x_data=zq_fds, y_data=vq_fds,
                                           data_label=f'{Q[i]} kW', marker_style=mark[i], figure_handle=fig_v)
     fig_v.savefig(os.path.join(pltdir, f'McCaffrey_Velocity_Correlation_{res}.pdf'))
     plt.close(fig_v)
@@ -189,7 +190,7 @@
                                    x_label=r'$z/Q^{2/5}$ $({\rm m kW}^{-2/5})$',
                                    y_label=r'$\Delta{T}$ ($^\circ$C)',
                                    plot_title=f'McCaffrey Centerline Temperature, {res}',
-                                   legend_location='lower right',
+                                   legend_location='lower left',
                                    plot_type='loglog')
 
     for i, c in enumerate(chid):
@@ -203,7 +204,7 @@
                 z = M.iloc[:, 0].values
                 T = M.iloc[:, 2].values + 273.15 if M.shape[1] > 2 else M.iloc[:, 1].values + 273.15
             zq_fds = z / (Q[i]**(2.0/5.0))
-            fdsplotlib.plot_to_fig(x_data=zq_fds, y_data=T-T0, 
+            fdsplotlib.plot_to_fig(x_data=zq_fds, y_data=T-T0,
                                           data_label=f'{Q[i]} kW', marker_style=mark[i], figure_handle=fig_t)
     fig_t.savefig(os.path.join(pltdir, f'McCaffrey_Temperature_Correlation_{res}.pdf'))
     plt.close(fig_t)