Skip to content

config

Configuration Options

C

Names used in config object

Source code in mmg_toolbox/tkguis/misc/config.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class C:
    """Names used in config object"""
    conf_file = 'config_file'
    default_directory = 'default_directory'
    processing_directory = 'processing_directory'
    notebook_directory = 'notebook_directory'
    recent_data_directories = 'recent_data_directories'
    small_screen_height = 'small_screen_height'
    text_size = 'text_size'
    text_size_small = 'text_size_small'
    plot_size = 'plot_size'
    image_size = 'image_size'
    plot_max_percent = 'plot_max_percent'
    plot_dpi = 'plot_dpi'
    plot_title = 'plot_title'
    normalise_factor = 'normalise_factor'
    replace_names = 'replace_names'
    metadata_string = 'metadata_string'
    metadata_list = 'metadata_list'
    metadata_label = 'metadata_label'
    default_colormap = 'default_colormap'
    beamline = 'beamline'
    roi = 'roi'
    current_dir = 'current_dir'
    current_proc = 'current_proc'
    current_nb = 'current_nb'

check_config_filename(config_filename)

Check config filename is writable, raise OSError if not

Source code in mmg_toolbox/tkguis/misc/config.py 
140
141
142
143
144
def check_config_filename(config_filename: str | None) -> str:
    """Check config filename is writable, raise OSError if not"""
    if config_filename is None:
        config_filename = CONFIG_FILE
    return check_file_access(config_filename)

reset_config(config)

Reset config dict in place with default values of beamline

Source code in mmg_toolbox/tkguis/misc/config.py 
171
172
173
174
175
def reset_config(config: dict) -> None:
    """Reset config dict in place with default values of beamline"""
    beamline = config.get(C.beamline, None)
    config.clear()
    config.update(default_config(beamline))