Skip to content

Image Viewer

image_viewer

cctbx_start

Attributes

logger module-attribute 

logger = getLogger(__name__)

Functions

image_viewer 

image_viewer(exp, run, facility, image_type, group, debug)
Source code in scripts/cctbx/image_viewer.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
def image_viewer(exp, run, facility, image_type, group, debug):
    logging.info(f"Opening image viewer for {image_type}")
    run = str(run).zfill(4)
    run = f'r{run}'

    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/image_viewer.sh "
                f"{exp} {facility} {image_type} {run} {group}"
            ]
    elif facility == "S3DF":
        proc = [
                f"ssh -YAC psana "
                f"/sdf/group/lcls/ds/tools/mfx/scripts/cctbx/image_viewer.sh "
                f"{exp} {facility} {image_type} {run} {group}"
            ]
    else:
        logging.warning(f"Facility not found: {facility}")

    logging.info(proc)
    if debug:
        os.system(proc[0])
    else:
        subprocess.Popen(
            proc, shell=True,
            stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)

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/image_viewer.py 
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
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)
    exp = args.experiment
    facility = args.facility
    debug = bool(args.debug)
    image_type = args.image_type.lower()
    run = args.run
    group = args.group

    image_viewer(exp, run, facility, image_type, group, debug)

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/image_viewer.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
 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
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(
        "--experiment",
        "-e",
        dest="experiment",
        default=None,
        help="Enter -e to specify experiment number",
    )
    parser.add_argument(
        "--facility",
        "-f",
        dest="facility",
        default=None,
        help="Enter -f to specify facility",
    )
    parser.add_argument(
        "--debug",
        "-d",
        dest="debug",
        default=str(False),
        help="Enter -d to set debugging mode",
    )
    parser.add_argument(
        "--image_type",
        "-t",
        dest="image_type",
        default=None,
        help="Enter -t for type of image view",
    )
    parser.add_argument(
        "--run",
        "-r",
        dest="run",
        default=None,
        help="Enter -r for the run number",
    )
    parser.add_argument(
        "--group",
        "-g",
        dest="group",
        default=None,
        help="Enter -g for the trial "+
        "and rungroup number in the format 000_rg005."+
        "Default is newest folder"
    )

    return parser.parse_args(args)

run 

run()

Entry point for console_scripts

Source code in scripts/cctbx/image_viewer.py 
122
123
124
def run():
    """Entry point for console_scripts"""
    main(sys.argv[1:])