Skip to content

ask_user_config

This module contains functions to prompt the user for various job configuration settings.

Functions:

Name Description
ask_and_set_gpu

dict[str, Any]) -> None:
ask_and_set_htc_flavour

dict[str, Any]) -> None:
ask_and_set_run_on

dict[str, Any]) -> None:
ask_keep_setting

str) -> bool:
ask_skip_configured_jobs

ask_and_set_gpu(dic_gen)

Prompts the user if a GPU must be used for the job and sets it in the provided dictionary.

Parameters:

Name Type Description Default
dic_gen dict[str, Any]

The dictionary containing job configuration.

 required
Source code in study_da/submit/ask_user_config.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
def ask_and_set_gpu(dic_gen: dict[str, Any]) -> None:
    """
    Prompts the user if a GPU must be used for the job and sets it in the provided dictionary.

    Args:
        dic_gen (dict[str, Any]): The dictionary containing job configuration.
    """
    while True:
        gpu = input(
            f"Do you want to request a GPU for job {dic_gen['file']}?" " (y/n). Default is n."
        )
        gpu = "n" if gpu == "" else gpu
        if gpu in ["y", "n", ""]:
            break

    dic_gen["request_gpu"] = gpu == "y"

ask_and_set_htc_flavour(dic_gen)

Prompts the user to select an HTCondor job flavor and sets it in the provided dictionary.

Parameters:

Name Type Description Default
dic_gen dict[str, Any]

The dictionary containing job configuration.

 required
Source code in study_da/submit/ask_user_config.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
def ask_and_set_htc_flavour(dic_gen: dict[str, Any]) -> None:
    """
    Prompts the user to select an HTCondor job flavor and sets it in the provided dictionary.

    Args:
        dic_gen (dict[str, Any]): The dictionary containing job configuration.
    """
    while True:
        try:
            submission_type = input(
                f"What type of htc job flavour do you want to use for job {dic_gen['file']}?"
                f" 1: espresso, 2: microcentury, 3: longlunch, 4: workday, 5: tomorrow,"
                f" 6: testmatch, 7: nextweek. Default is espresso."
            )
            submission_type = 1 if submission_type == "" else int(submission_type)
            if submission_type in range(1, 8):
                break
            else:
                raise ValueError
        except ValueError:
            print("Invalid input. Please enter a number between 1 and 7.")

    dict_flavour_type = {
        1: "espresso",
        2: "microcentury",
        3: "longlunch",
        4: "workday",
        5: "tomorrow",
        6: "testmatch",
        7: "nextweek",
    }
    dic_gen["htc_flavor"] = dict_flavour_type[submission_type]

ask_and_set_run_on(dic_gen)

Prompts the user to select a submission type and sets it in the provided dictionary.

Parameters:

Name Type Description Default
dic_gen dict[str, Any]

The dictionary containing job configuration.

 required
Source code in study_da/submit/ask_user_config.py 
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
def ask_and_set_run_on(dic_gen: dict[str, Any]) -> None:
    """
    Prompts the user to select a submission type and sets it in the provided dictionary.

    Args:
        dic_gen (dict[str, Any]): The dictionary containing job configuration.
    """
    while True:
        try:
            submission_type = input(
                f"What type of submission do you want to use for job {dic_gen['file']}?"
                " 1: local, 2: htc, 3: htc_docker, 4: slurm, 5: slurm_docker. Default is local."
            )
            submission_type = 1 if submission_type == "" else int(submission_type)
            if submission_type in range(1, 6):
                break
            else:
                raise ValueError
        except ValueError:
            print("Invalid input. Please enter a number between 1 and 5.")

    dict_submission_type = {
        1: "local",
        2: "htc",
        3: "htc_docker",
        4: "slurm",
        5: "slurm_docker",
    }
    dic_gen["submission_type"] = dict_submission_type[submission_type]

ask_keep_setting(job_name)

Prompts the user to decide whether to keep the same settings for identical jobs.

Returns:

Name Type Description
bool bool

True if the user wants to keep the same settings, False otherwise.
Source code in study_da/submit/ask_user_config.py 
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
def ask_keep_setting(job_name: str) -> bool:
    """
    Prompts the user to decide whether to keep the same settings for identical jobs.

    Returns:
        bool: True if the user wants to keep the same settings, False otherwise.
    """
    keep_setting = input(
        f"Do you want to keep the same setting for all jobs of the type {job_name} ? (y/n)."
        f"Default is y."
    )
    while keep_setting not in ["", "y", "n"]:
        keep_setting = input("Invalid input. Please enter y, n or skip question.")
    if keep_setting == "":
        keep_setting = "y"
    return keep_setting == "y"

ask_skip_configured_jobs()

Prompts the user to decide whether to skip already configured jobs.

Returns:

Name Type Description
bool bool

True if the user wants to skip already configured jobs, False otherwise.
Source code in study_da/submit/ask_user_config.py 
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
def ask_skip_configured_jobs() -> bool:
    """
    Prompts the user to decide whether to skip already configured jobs.

    Returns:
        bool: True if the user wants to skip already configured jobs, False otherwise.
    """
    skip_configured_jobs = input(
        "Some jobs to submit seem to be configured already. Do you want to skip them? (y/n). "
        "Default is y."
    )
    while skip_configured_jobs not in ["", "y", "n"]:
        skip_configured_jobs = input("Invalid input. Please enter y, n or skip question.")
    if skip_configured_jobs == "":
        skip_configured_jobs = "y"
    return skip_configured_jobs == "y"