Functions reference

Functions reference#

Plotting functions in tcplotter#

time_vs_temp#

tcplotter.time_vs_temp(cooling_rate_min=0.1, cooling_rate_slow=1.0, cooling_rate_avg=10.0, cooling_rate_max=100.0, temp_max=350.0, time_max=50.0, save_plot=False, plot_file_format='pdf', plot_dpi=300, plot_style='seaborn-v0_8-whitegrid', fill_between=True, display_plot=True)#

Plots cooling rate lines for different input rates.

Parameters:

  • cooling_rate_min (float or int, default=0.1) – Minimum cooling rate to plot in degrees C / Myr.

  • cooling_rate_slow (float or int, default=1.0) – “Slow” cooling rate to plot in degrees C / Myr.

  • cooling_rate_avg (float or int, default=10.0) – “Average” cooling rate to plot in degrees C / Myr.

  • cooling_rate_max (float or int, default=100.0) – Maximum cooling rate to plot in degrees C / Myr.

  • temp_max (float or int, default=350.0) – Maximum temperature for cooling history in degrees C.

  • time_max (float or int, default=50.0) – Maximum value for time on x-axis of plot in millions of years ago (Ma).

  • save_plot (bool, default=False) – Flag for whether to save the plot to a file.

  • plot_file_format (str, default='pdf') – File format for saving plot to file (examples: png, pdf, svg, eps).

  • plot_dpi (int, default=300) – Saved plot resolution in dots per inch.

  • plot_style (str, default='seaborn-v0_8-whitegrid') – Style sheet used for plotting. See https://matplotlib.org/stable/gallery/style_sheets/style_sheets_reference.html.

  • fill_between (bool, default=True) – Flag for whether to fill area between min, max cooling rates.

  • display_plot (bool, default=True) – Flag for whether to display the plot.

Return type:

None

eu_vs_radius#

tcplotter.eu_vs_radius(num_points=21, cooling_hist_type=1, temp_max=350.0, cooling_rate=10.0, time_hist=[0.0, 10.0, 25.0, 35.0], temp_hist=[0.0, 75.0, 50.0, 350.0], ap_u_min=1.0, ap_u_max=150.0, zr_u_min=1.0, zr_u_max=4000.0, ap_rad_min=40.0, ap_rad_max=100.0, zr_rad_min=40.0, zr_rad_max=100.0, ap_thorium=0.0, zr_thorium=0.0, plot_type=3, save_plot=False, plot_file_format='pdf', plot_dpi=300, plot_style='seaborn-v0_8-colorblind', plot_colormap='plasma', plot_alpha=1.0, plot_contour_lines=12, plot_contour_fills=256, age_data_file='', input_tt_file='', calc_misfit=False, display_plot=True, tt_plot=False, verbose=False, use_widget=False)#

Calculates thermochronometer ages and closure temperatures for different effective uranium concentrations and equivalent spherical radii.

Parameters:

  • num_points (int, default=21) – Number of points along x and y axes where ages/closure temperatures are calculated. NOTE: A value of num_points = 101 was used in the manuscript. It has been reduced here to make the plotting faster. Set this to 101 to reproduce the manuscript Figures 2 or 3.

  • cooling_hist_type (int, default=1) – Cooling history type. 1 = constant cooling rate (specify rate as parameter rate) 2 = list of time-temperature points (fill in lists as parameters time_hist, temp_hist) 3 = time-temperature history file (csv file, times and temperatures in first 2 columns)

  • temp_max (float, default=350.0) – Max temperature for cooling history (in degrees C). Option only for cooling history type 1.

  • cooling_rate (float, default=10.0) – Cooling rate in degrees C per Myr. Option only for cooling history type 1.

  • time_hist (list of floats or ints, default=[0.0, 10.0, 25.0, 35.0]) – Time points defining cooling history in Ma (millions of years ago). NOTE: Present-day point should be first in list. Option only for cooling history type 2.

  • temp_hist (list of floats or ints, default=[0.0, 75.0, 50.0, 350.0]) – Temperature points defining cooling history in degrees C. NOTE: Present-day point should be first in list. Option only for cooling history type 2.

  • ap_u_min (float, default=1.0) – Minimum apatite uranium concentration in ppm.

  • ap_u_max (float, default=150.0) – Maximum apatite uranium concentration in ppm.

  • zr_u_min (float, default=1.0) – Minimum zircon uranium concentration in ppm.

  • zr_u_max (float, default=4000.0) – Maximum zircon uranium concentration in ppm.

  • ap_rad_min (float, default=40.0) – Minimum apatite equivalent spherical grain radius in micrometers.

  • ap_rad_max (float, default=100.0) – Maximum apatite equivalent spherical grain radius in micrometers.

  • zr_rad_min (float, default=40.0) – Minimum zircon equivalent spherical grain radius in micrometers.

  • zr_rad_max (float, default=100.0) – Maximum zircon equivalent spherical grain radius in micrometers.

  • ap_thorium (float, default=0.0) – Apatite thorium concentration in ppm.

  • zr_thorium (float, default=0.0) – Zircon thorium concentration in ppm.

  • plot_type (int, default=3) – eU versus radius plot type. 1 = apatite, 2 = zircon, 3 = both

  • save_plot (bool, default=False) – Flag for whether to save the plot to a file.

  • plot_file_format (str, default='pdf') – File format for saving plot(s) to file (examples: png, pdf, svg, eps).

  • plot_dpi (int, default=300) – Saved plot resolution in dots per inch.

  • plot_style (str, default='seaborn-v0_8-colorblind') – Style sheet used for plotting. See https://matplotlib.org/stable/gallery/style_sheets/style_sheets_reference.html.

  • plot_colormap (str, default='plasma') – Colormap used for plotting. See https://matplotlib.org/stable/tutorials/colors/colormaps.html.

  • plot_alpha (float, default=1.0) – Transparency used for plotting fill colors.

  • plot_contour_lines (int, default=12) – Number of contour lines used for plotting.

  • plot_contour_fills (int, default=256) – Number of contour fill colors from the selected colormap.

  • age_data_file (str, default='') – Filename for file containing measured thermochronometer ages.

  • input_tt_file (str, default='') – Filename for file containing time-temperature history.

  • calc_misfit (bool, default=False) – Flag for whether a misfit should be calculated for measured and predicted ages.

  • display_plot (bool, default=True) – Flag for whether to display the plot.

  • tt_plot (bool, default=False) – Flag for whether to create/display the time-temperature history plot.

  • verbose (bool, default=False) – Enable/disable verbose output.

  • use_widget (bool, default=False) – Enable/disable IPython progress bar widget. Disabled for command-line usage.

rate_vs_radius_eu#

tcplotter.rate_vs_radius_eu(num_points=21, cooling_rate_min=0.1, cooling_rate_max=100.0, temp_max=350.0, ap_u_min=1.0, ap_u_max=150.0, ap_u_ref=10.0, zr_u_min=1.0, zr_u_max=4000.0, zr_u_ref=100.0, ap_rad_min=40.0, ap_rad_max=100.0, ap_rad_ref=45.0, zr_rad_min=40.0, zr_rad_max=100.0, zr_rad_ref=60.0, ap_thorium=0.0, zr_thorium=0.0, plot_type=3, save_plot=False, plot_file_format='pdf', plot_dpi=300, plot_style='seaborn-v0_8-colorblind', plot_colormap='plasma', plot_alpha=1.0, plot_contour_lines=12, plot_contour_fills=256, display_plot=True, verbose=False, use_widget=False)#

Calculates thermochronometer ages and closure temperatures for different cooling rates, effective uranium concentrations, and equivalent spherical radii.

Parameters:

  • num_points (int, default=21) – Number of points along x and y axes where ages/closure temperatures are calculated. NOTE: A value of num_points = 101 was used in the manuscript. It has been reduced here to make the plotting faster. Set this to 101 to reproduce the manuscript Figure 4.

  • cooling_rate_min (float, default=0.1) – Minimum cooling rate in degrees C per Myr.

  • cooling_rate_max (float, default=100.0) – Maximum cooling rate in degrees C per Myr.

  • temp_max (float, default=350.0) – Max temperature for cooling history (in degrees C).

  • ap_u_min (float, default=1.0) – Minimum apatite uranium concentration in ppm.

  • ap_u_max (float, default=150.0) – Maximum apatite uranium concentration in ppm.

  • ap_u_ref (float, default=10.0) – Apatite uranium concentration in ppm for rate versus radius plot.

  • zr_u_min (float, default=1.0) – Minimum zircon uranium concentration in ppm.

  • zr_u_max (float, default=4000.0) – Maximum zircon uranium concentration in ppm.

  • zr_u_ref (float, default=100.0) – Zircon uranium concentration in ppm for rate versus radius plot.

  • ap_rad_min (float, default=40.0) – Minimum apatite equivalent spherical grain radius in micrometers.

  • ap_rad_max (float, default=100.0) – Maximum apatite equivalent spherical grain radius in micrometers.

  • ap_rad_ref (float, default=45.0) – Apatite equivalent spherical grain radius in micrometers for rate versus eU plot.

  • zr_rad_min (float, default=40.0) – Minimum zircon equivalent spherical grain radius in micrometers.

  • zr_rad_max (float, default=100.0) – Maximum zircon equivalent spherical grain radius in micrometers.

  • zr_rad_ref (float, default=60.0) – Zircon equivalent spherical grain radius in micrometers for rate versus eU plot.

  • ap_thorium (float, default=0.0) – Apatite thorium concentration in ppm.

  • zr_thorium (float, default=0.0) – Zircon thorium concentration in ppm.

  • plot_type (int, default=3) – Cooling rate versus eU/radius. 1 = apatite, 2 = zircon, 3 = both

  • save_plot (bool, default=False) – Flag for whether to save the plot to a file.

  • plot_file_format (str, default='pdf') – File format for saving plot to file (examples: png, pdf, svg, eps).

  • plot_dpi (int, default=300) – Saved plot resolution in dots per inch.

  • plot_style (str, default='seaborn-v0_8-colorblind') – Style sheet used for plotting. See https://matplotlib.org/stable/gallery/style_sheets/style_sheets_reference.html.

  • plot_colormap (str, default='plasma') – Colormap used for plotting. See https://matplotlib.org/stable/tutorials/colors/colormaps.html.

  • plot_alpha (float, default=1.0) – Transparency used for plotting fill colors.

  • plot_contour_lines (int, default=12) – Number of contour lines used for plotting.

  • plot_contour_fills (int, default=256) – Number of contour fill colors from the selected colormap.

  • display_plot (bool, default=True) – Flag for whether to display the plot.

  • verbose (bool, default=False) – Enable/disable verbose output.

  • use_widget (bool, default=False) – Enable/disable IPython progress bar widget. Disabled for command-line usage.

Return type:

None

rate_vs_age_tc#

tcplotter.rate_vs_age_tc(num_points=101, cooling_rate_min=0.1, cooling_rate_max=100.0, temp_max=350.0, ap_u1=1.0, ap_u2=20.0, ap_u3=150.0, zr_u1=10.0, zr_u2=200.0, zr_u3=4000.0, ap_rad=45.0, zr_rad=60.0, ap_thorium=0.0, zr_thorium=0.0, ahe_uncertainty=0.1, aft_uncertainty=0.2, zhe_uncertainty=0.1, plot_type=3, plot_age_min=0.5, plot_age_max=1800.0, plot_tc_min=0.0, plot_tc_max=200.0, save_plot=False, plot_file_format='pdf', plot_dpi=300, plot_style='seaborn-v0_8-colorblind', plot_alpha=0.6, plot_grid=True, display_plot=True, clean_up_files=True, verbose=False, use_widget=False)#

Calculates thermochronometer ages and closure temperatures for different cooling rates and effective uranium concentrations.

Parameters:

  • num_points (int, default=101) – Number of points along x and y axes where ages/closure temperatures are calculated.

  • cooling_rate_min (float, default=0.1) – Minimum cooling rate in degrees C per Myr.

  • cooling_rate_max (float, default=100.0) – Maximum cooling rate in degrees C per Myr.

  • temp_max (float, default=350.0) – Max temperature for cooling history (in degrees C).

  • ap_u1 (float, default=1.0) – Apatite uranium concentration in ppm for upper plot panel.

  • ap_u2 (float, default=10.0) – Apatite uranium concentration in ppm for middle plot panel.

  • ap_u3 (float, default=150.0) – Apatite uranium concentration in ppm for lower plot panel.

  • zr_u1 (float, default=10.0) – Zircon uranium concentration in ppm for upper plot panel.

  • zr_u2 (float, default=200.0) – Zircon uranium concentration in ppm for middle plot panel.

  • zr_u3 (float, default=4000.0) – Zircon uranium concentration in ppm for lower plot panel.

  • ap_rad (float, default=45.0) – Apatite equivalent spherical grain radius in micrometers.

  • zr_rad (float, default=60.0) – Zircon equivalent spherical grain radius in micrometers.

  • ap_thorium (float, default=0.0) – Apatite thorium concentration in ppm.

  • zr_thorium (float, default=0.0) – Zircon thorium concentration in ppm.

  • ahe_uncertainty (float, default=0.1) – Apatite (U-Th)/He age uncertainty fraction (0.1 = 10%)

  • aft_uncertainty (float, default=0.2) – Apatite fission-track age uncertainty fraction (0.2 = 20%)

  • zhe_uncertainty (float, default=0.1) – Zircon (U-Th)/He age uncertainty fraction (0.1 = 10%)

  • plot_type (int, default=3) – 1 = Cooling rate versus closure temperature 2 = Cooling rate versus age 3 = Cooling rate versus age and closure temperature

  • plot_age_min (float, default=0.5) – Minimum age value in Ma for plots of cooling rate versus age. Only applies to plot_type 2 and 3.

  • plot_age_max (float, default=1800.0) – Maximum age value in Ma for plots of cooling rate versus age. Only applies to plot_type 2 and 3.

  • plot_tc_min (float, default=0.0) – Minimum closure temperature value in deg. C for plots of cooling rate versus closure temperature. Only applies to plot_type 1 and 3.

  • plot_tc_max (float, default=200.0) – Maximum closure temperature value in deg. C for plots of cooling rate versus closure temperature. Only applies to plot_type 1 and 3.

  • save_plot (bool, default=False) – Flag for whether to save the plot to a file.

  • plot_file_format (str, default='pdf') – File format for saving plot to file (examples: png, pdf, svg, eps).

  • plot_dpi (int, default=300) – Saved plot resolution in dots per inch.

  • plot_style (str, default='seaborn-v0_8-colorblind') – Style sheet used for plotting. See https://matplotlib.org/stable/gallery/style_sheets/style_sheets_reference.html.

  • plot_alpha (float, default=0.6) – Transparency used for plotting fill colors for age swath plots.

  • plot_grid (bool, default=True) – Flag for whether or not to display the plot grid lines.

  • display_plot (bool, default=True) – Flag for whether to display the plot.

  • clean_up_files (bool, default=True) – Flag for whether to delete temporary output files after the code has run.

  • verbose (bool, default=False) – Enable/disable verbose output.

  • use_widget (bool, default=False) – Enable/disable IPython progress bar widget. Disabled for command-line usage.

Return type:

None

Contents