25223758709

Committed 01 May 2026 04:46PM UTC coverage: 56.446% (-34.1%) from 90.54%

Build # 25223758709

Build Type

push

github

Committed by

jameswilburlewis

Commit Message

Temporarily disabling Cluster tests due to problems at CSA

Coverage Stats

27633 of 48955 relevant lines covered (56.45%)

0.56 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

78.38

/pyspedas/tplot_tools/tplot_options.py

import logging
import pyspedas


def set_tplot_options(option, value, old_tplot_opt_glob):
    new_tplot_opt_glob = old_tplot_opt_glob

    if option in ['title_text', 'title']:
        new_tplot_opt_glob['title_text'] = value

    elif option == 'title_size':
        new_tplot_opt_glob['title_size'] = value

    elif option == 'var_label':
        new_tplot_opt_glob['var_label'] = value

    elif option == 'x_range':
        new_tplot_opt_glob['x_range'] = value

    elif option == 'data_gap':
        new_tplot_opt_glob['data_gap'] = value

    elif option == 'axis_font_size':
        new_tplot_opt_glob['axis_font_size'] = value

    elif option == 'xmargin':
        new_tplot_opt_glob['xmargin'] = value

    elif option == 'ymargin':
        new_tplot_opt_glob['ymargin'] = value

    elif option == 'style':
        new_tplot_opt_glob['style'] = value

    elif option == 'charsize':
        new_tplot_opt_glob['charsize'] = value

    elif option == 'xsize':
        new_tplot_opt_glob['xsize'] = value

    elif option == 'ysize':
        new_tplot_opt_glob['ysize'] = value

    elif option == 'varlabel_style':
        new_tplot_opt_glob['varlabel_style'] = value

    else:
        logging.warning("Unknown option supplied: " + str(option))

    return new_tplot_opt_glob


def tplot_options(option, value):
    """
    This function allows the user to set GLOBAL options for the generated plots.
    
    Parameters
    ----------
        option : str
            The name of the option.  See section below  
        value : str/int/float/list
            The value of the option.  See section below.  
            
    Options
    -------
        ==================  ==========   =====
        Option (Synonyms)   Value type   Notes
        ==================  ==========   =====
        title_text (title)  str          Title of the entire plot (mpl 'suptitle', above any panel titles)
        title_size          int          Font size of the title
        data_gap            int          Number of seconds with consecutive nan values allowed before no interp should occur
        x_range             [flt, flt]   The min and max x_range (time) to be plotted on all plots
        axis_font_size      int          The font size of the axis ticks.  Default is 10.
        charsize            int          The font size for the legend strings
        style               str          The matplotlib plot style to use
        xsize               flt          The size of the plot window in the X dimension (units of inches)
        ysize               flt          The size of the plot window in the Y dimension (units of inches)
        xmargin             [flt, flt]   The width of the left and right margins of the plot (in inches)
        ymargin             [flt, flt]   The height of the top and bottom margins of the plot (in inches)
        annotations         dict         A dictionary of text, positions, xycoords, and other options to be placed on the plot
        varlabel_style      str          Set to 'extra_axes' for each variable on its own axis, or 'extra_panel' for a more compact display in a single panel
        ==================  ==========   =====

    Returns
    -------
        None
    
    Examples
    --------
        >>> # Set the plot title
        >>> import pyspedas
        >>> pyspedas.tplot_options('title', 'SWEA Data for Orbit 1563')
    
    """


    option = option.lower()
    
    temp = set_tplot_options(option, value, pyspedas.tplot_tools.tplot_opt_glob)
    pyspedas.tplot_tools.tplot_opt_glob = temp
    
    return

1	import logging	1✔
2	import pyspedas	1✔
3
4
5	def set_tplot_options(option, value, old_tplot_opt_glob):	1✔
6	new_tplot_opt_glob = old_tplot_opt_glob	1✔
7
8	if option in ['title_text', 'title']:	1✔
9	new_tplot_opt_glob['title_text'] = value	1✔
10
11	elif option == 'title_size':	1✔
12	new_tplot_opt_glob['title_size'] = value	1✔
13
14	elif option == 'var_label':	1✔
15	new_tplot_opt_glob['var_label'] = value	×
16
17	elif option == 'x_range':	1✔
18	new_tplot_opt_glob['x_range'] = value	×
19
20	elif option == 'data_gap':	1✔
21	new_tplot_opt_glob['data_gap'] = value	×
22
23	elif option == 'axis_font_size':	1✔
24	new_tplot_opt_glob['axis_font_size'] = value	1✔
25
26	elif option == 'xmargin':	1✔
27	new_tplot_opt_glob['xmargin'] = value	1✔
28
29	elif option == 'ymargin':	1✔
30	new_tplot_opt_glob['ymargin'] = value	×
31
32	elif option == 'style':	1✔
33	new_tplot_opt_glob['style'] = value	×
34
35	elif option == 'charsize':	1✔
36	new_tplot_opt_glob['charsize'] = value	1✔
37
38	elif option == 'xsize':	1✔
39	new_tplot_opt_glob['xsize'] = value	×
40
41	elif option == 'ysize':	1✔
42	new_tplot_opt_glob['ysize'] = value	×
43
44	elif option == 'varlabel_style':	1✔
45	new_tplot_opt_glob['varlabel_style'] = value	1✔
46
47	else:
48	logging.warning("Unknown option supplied: " + str(option))	×
49
50	return new_tplot_opt_glob	1✔
51
52
53	def tplot_options(option, value):	1✔
54	"""
55	This function allows the user to set GLOBAL options for the generated plots.
56
57	Parameters
58	----------
59	option : str
60	The name of the option. See section below
61	value : str/int/float/list
62	The value of the option. See section below.
63
64	Options
65	-------
66	================== ========== =====
67	Option (Synonyms) Value type Notes
68	================== ========== =====
69	title_text (title) str Title of the entire plot (mpl 'suptitle', above any panel titles)
70	title_size int Font size of the title
71	data_gap int Number of seconds with consecutive nan values allowed before no interp should occur
72	x_range [flt, flt] The min and max x_range (time) to be plotted on all plots
73	axis_font_size int The font size of the axis ticks. Default is 10.
74	charsize int The font size for the legend strings
75	style str The matplotlib plot style to use
76	xsize flt The size of the plot window in the X dimension (units of inches)
77	ysize flt The size of the plot window in the Y dimension (units of inches)
78	xmargin [flt, flt] The width of the left and right margins of the plot (in inches)
79	ymargin [flt, flt] The height of the top and bottom margins of the plot (in inches)
80	annotations dict A dictionary of text, positions, xycoords, and other options to be placed on the plot
81	varlabel_style str Set to 'extra_axes' for each variable on its own axis, or 'extra_panel' for a more compact display in a single panel
82	================== ========== =====
83
84	Returns
85	-------
86	None
87
88	Examples
89	--------
90	>>> # Set the plot title
91	>>> import pyspedas
92	>>> pyspedas.tplot_options('title', 'SWEA Data for Orbit 1563')
93
94	"""
95
96
97	option = option.lower()	1✔
98
99	temp = set_tplot_options(option, value, pyspedas.tplot_tools.tplot_opt_glob)	1✔
100	pyspedas.tplot_tools.tplot_opt_glob = temp	1✔
101
102	return	1✔

spedas / pyspedas / 25223758709

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous