Skip to content

Energy Calib Output

energy_calib_output

fee_spec

Attributes

logger module-attribute 

logger = getLogger(__name__)

Functions

main 

main(args)

Main entry point allowing external calls Entry point for console_scripts Args: args ([str]): command line parameter list

Source code in scripts/cctbx/energy_calib_output.py 
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
def main(args):
    """
    Main entry point allowing external calls
    Entry point for console_scripts
    Args:
      args ([str]): command line parameter list
    """
    args = parse_args(args)
    facility = args.facility
    run_type = args.run_type
    exp = args.experiment
    run = args.run
    energy = args.energy
    step = args.step
    num = args.num

    output(facility, run_type, exp, run, energy, step, num)

output 

output(facility: str = 'S3DF', run_type: str = None, exp: str = None, run: str = None, energy: float = None, step: float = None, num: int = None)

Generates the output of the energy scan or series.

Parameters: facility (str): Default: "S3DF". Options: "S3DF, NERSC type (str): specify whether it is a vernier 'scan' or 'series' exp (str): experiment number. Current experiment by default run (str): The run you'd like to process energy (float): specify the starting energy in eV (only for 'series') step (float): specify the energy step size in eV (only for 'series') num (int): specify the total number of runs (only for 'series')

Source code in scripts/cctbx/energy_calib_output.py 
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
def output(
        facility: str = "S3DF",
        run_type: str = None,
        exp: str = None,
        run: str = None,
        energy: float = None,
        step: float = None,
        num: int = None):
    """ Generates the output of the energy scan or series.

    Parameters:
        facility (str):
            Default: "S3DF". Options: "S3DF, NERSC
        type (str):
            specify whether it is a vernier 'scan' or 'series'
        exp (str): 
            experiment number. Current experiment by default
        run (str): 
            The run you'd like to process
        energy (float):
            specify the starting energy in eV (only for 'series')
        step (float):
            specify the energy step size in eV (only for 'series')
        num (int):
            specify the total number of runs (only for 'series')
    """

    if run_type != 'scan' and run_type != 'series':
        logging.error("Enter -t to specify whether it is a vernier 'scan' or 'series'. Program Exit.")
        sys.exit()

    if facility == "NERSC":
        exp = exp[3:-2]
        proc = [
                f"ssh -i ~/.ssh/cctbx -YAC cctbx@perlmutter-p1.nersc.gov "
                f"/global/common/software/lcls/mfx/scripts/cctbx/energy_calib_output.sh "
                f"{facility} {run_type} {exp} {run} {energy} {step} {num}"
            ]
    elif facility == "S3DF":
        proc = [
                f"ssh -YAC psana "
                f"/sdf/group/lcls/ds/tools/mfx/scripts/cctbx/energy_calib_output.sh "
                f"{facility} {run_type} {exp} {run} {energy} {step} {num}"
            ]
    else:
        logging.error(f"Facility not found: {facility}. Program Exit.")
        sys.exit()

    logging.info(proc)
    os.system(proc[0])

parse_args 

parse_args(args)

Parse command line parameters

Args: args ([str]): command line parameters as list of strings

Returns: :obj:argparse.Namespace: command line parameters namespace

Source code in scripts/cctbx/energy_calib_output.py 
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
def parse_args(args):
    """Parse command line parameters

    Args:
      args ([str]): command line parameters as list of strings

    Returns:
      :obj:`argparse.Namespace`: command line parameters namespace
    """
    parser = argparse.ArgumentParser(
        description="startup script for cctbx on iana."
    )
    parser.add_argument(
        "--facility",
        "-f",
        dest="facility",
        default=None,
        help="Enter -f to specify facility",
    )
    parser.add_argument(
        "--type",
        "-t",
        dest="run_type",
        default=None,
        help="Enter -t to specify whether it is a vernier 'scan' or 'series'",
    )
    parser.add_argument(
        "--experiment",
        "-e",
        dest="experiment",
        default=None,
        help="Enter -e to specify experiment number",
    )
    parser.add_argument(
        "--run",
        "-r",
        dest="run",
        default=None,
        help="Enter -r for the run you'd like to process."
    )
    parser.add_argument(
        "--energy",
        "-z",
        dest="energy",
        default=None,
        help="Enter -z to specify the starting energy in eV (only for 'series')",
    )
    parser.add_argument(
        "--step",
        "-s",
        dest="step",
        default=None,
        help="Enter -s to specify the energy step size in eV (only for 'series')",
    )
    parser.add_argument(
        "--num",
        "-n",
        dest="num",
        default=None,
        help="Enter -n to specify the total number of runs (only for 'series')",
    )
    return parser.parse_args(args)

run 

run()

Entry point for console_scripts

Source code in scripts/cctbx/energy_calib_output.py 
150
151
152
def run():
    """Entry point for console_scripts"""
    main(sys.argv[1:])