aboutsummaryrefslogtreecommitdiffstats
path: root/astro/oskar/run_oskar.py
blob: 19f1ae90bb107b9628ac6f6a9c039f1fd918955b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
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
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
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
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
#!/usr/bin/env python3
#
# Copyright (c) 2017-2018 Weitian LI <weitian@aaronly.me>
# MIT License
#
# Run OSKAR interferometer simulator, with corresponding settings
# applied to the common configurations.
#
# OSKAR settings doc:
# http://www.oerc.ox.ac.uk/~ska/oskar2/OSKAR-Settings.pdf
#

import os
import re
import argparse
import subprocess
import shutil
from time import time


OSKAR_BIN = os.environ.get("OSKAR_BIN", "oskar_sim_interferometer")
print("OSKAR simulator: %s" % OSKAR_BIN)


def file_len(fname):
    """
    Get the number of lines of a text file.

    Credit: https://stackoverflow.com/q/845058/4856091
    """
    with open(fname) as f:
        for i, l in enumerate(f):
            pass
    return i+1


def run_oskar(configfile, model, freq, vis_ms, vis_oskar=None,
              telescope=None, chunksize=None, double_precision=None,
              use_gpus=None, gpu_ids=None, num_devices=None,
              dryrun=False):
    """
    Update simulation settings in the configuration file,
    and run the simulator ``oskar_sim_interferometer``.
    """
    if chunksize is not None:
        chunksize = int(chunksize)
    if vis_ms is None and vis_oskar is None:
        raise ValueError("both 'vis_oskar' & 'vis_ms' are missing")

    print("Updating simulation settings ...")
    for item, value in [
            ("simulator/max_sources_per_chunk",   chunksize),
            ("simulator/double_precision",        double_precision),
            ("simulator/use_gpus",                use_gpus),
            ("simulator/cuda_device_ids",         gpu_ids),
            ("simulator/num_devices",             num_devices),
            ("sky/oskar_sky_model/file",          model),
            ("telescope/input_directory",         telescope),
            ("observation/start_frequency_hz",    freq*1e6),  # [MHz] -> [Hz]
            ("interferometer/oskar_vis_filename", vis_oskar),
            ("interferometer/ms_filename",        vis_ms)]:
        if value is not None:
            subprocess.check_call([OSKAR_BIN, "--set",
                                   configfile, item, str(value)])
            print("Updated '%s' -> '%s'" % (item, str(value)))

    print("-------------------------------------------------------------")
    print("Simulating %s @ %.2f [MHz] ..." % (model, freq))
    cmd = [OSKAR_BIN, configfile]
    print("CWD: %s" % os.getcwd())
    print("CMD: %s" % " ".join(cmd))
    if dryrun:
        print("Dry run mode -> DONE!")
    else:
        tstart = time()
        subprocess.check_call(cmd)
        tcost = time() - tstart
        if tcost <= 3*60:
            print("Elapsed time: %.1f [sec]" % tcost)
        else:
            print("Elapsed time: %.1f [min]" % (tcost/60))
    print("-------------------------------------------------------------")


def main():
    default_fconfig = "sim_interferometer.f{freq:06.2f}.ini"
    parser = argparse.ArgumentParser(
        description="Run OSKAR simulator on a list of sky models",
        epilog="NOTE: use env variable 'OSKAR_BIN' to manually specify the " +
        "path to the simulator: 'oskar_sim_interferometer'")
    parser.add_argument("-d", "--dry-run", dest="dryrun", action="store_true",
                        help="dry run")
    parser.add_argument("-c", "--config", dest="config", required=True,
                        help="OSKAR base/common configuration file")
    parser.add_argument("-C", "--fconfig", dest="fconfig",
                        default=default_fconfig,
                        help="filename pattern of the configuration files " +
                        "updated for OSKAR usage " +
                        "(default: %s)" % default_fconfig)
    parser.add_argument("-S", "--max-chunk", dest="chunk_max", type=float,
                        help="maximum allowed chunk size; if the input " +
                        "sky model has less sources than this maximum " +
                        "chunk size, then use the input source number " +
                        "as the simulation chunk size.")
    parser.add_argument("--vis-oskar", dest="vis_oskar",
                        action="store_true",
                        help="also save visibility in OSKAR native format")
    parser.add_argument("-t", "--telescope", dest="telescope",
                        help="overwrite the telescope model in config file")
    parser.add_argument("-o", "--outdir", dest="outdir",
                        default="visibility",
                        help="simulated visibility output directory " +
                        "(default: 'visibility/')")
    parser.add_argument("--num-devices", dest="num_devices",
                        type=int, default=None,
                        help="number of CPU threads to use")
    parser.add_argument("--gpu-ids", dest="gpu_ids", default=None,
                        help="comma-separated GPU device IDs to use; " +
                        "(default: use all GPU devices)")
    exgrp1 = parser.add_mutually_exclusive_group()
    exgrp1.add_argument("--use-gpu", dest="use_gpu", action="store_true",
                        help="force to only use GPUs")
    exgrp1.add_argument("--use-cpu", dest="use_cpu", action="store_true",
                        help="force to only use CPUs")
    exgrp2 = parser.add_mutually_exclusive_group()
    exgrp2.add_argument("--use-double", dest="use_double", action="store_true",
                        help="use double-precision float numbers")
    exgrp2.add_argument("--use-single", dest="use_single", action="store_true",
                        help="use single-precision float numbers")
    exgrp3 = parser.add_mutually_exclusive_group(required=True)
    exgrp3.add_argument("-l", "--list", dest="listfile",
                        help="list of frequencies [MHz] and input sky models")
    exgrp3.add_argument("-i", "--items", dest="items", nargs="+",
                        help="list of sky model items in format of " +
                        "'<freq[MHz]>:<skymodel-file>'")
    args = parser.parse_args()
    tstart = time()

    use_gpus = None
    if args.use_gpu:
        use_gpus = True
    elif args.use_cpu:
        use_gpus = False

    double_precision = None
    if args.use_double:
        double_precision = True
    elif args.use_single:
        double_precision = False

    if not os.path.exists(args.outdir):
        os.mkdir(args.outdir)
        print("Created output visibility directory: %s" % args.outdir)

    skymodels = []
    if args.listfile:
        for line in open(args.listfile).readlines():
            if re.match(r"^(\s*$|\s*#)", line):
                continue
            freq, skyfile = line.strip().split()
            freq = float(freq)
            skymodels.append((freq, skyfile))
    else:
        for item in args.items:
            freq, skyfile = item.split(":")
            freq = float(freq)
            skymodels.append((freq, skyfile))

    Nosm = len(skymodels)
    print("Number of sky models: %d" % Nosm)

    for i, (freq, skyfile) in enumerate(skymodels):
        print("=============================================================")
        print("[%d/%d] %s @ %.2f [MHz]" % (i+1, Nosm, skyfile, freq))
        print("-------------------------------------------------------------")
        Nsrc = file_len(skyfile)
        print("Number of sources: ~{:,}".format(Nsrc))
        chunksize = args.chunk_max
        if chunksize and chunksize > Nsrc:
            chunksize = Nsrc
        basename = os.path.splitext(os.path.basename(skyfile))[0]
        if args.vis_oskar:
            vis_oskar = os.path.join(args.outdir, basename+".oskar")
        else:
            vis_oskar = None
        vis_ms = os.path.join(args.outdir, basename+".ms")
        configfile = args.fconfig.format(freq=freq)
        shutil.copy(args.config, configfile)
        print("Copied OSKAR configuration file as: %s" % configfile)
        run_oskar(configfile=configfile, freq=freq,
                  model=skyfile, vis_ms=vis_ms, vis_oskar=vis_oskar,
                  telescope=args.telescope, chunksize=chunksize,
                  double_precision=double_precision,
                  use_gpus=use_gpus, gpu_ids=args.gpu_ids,
                  num_devices=args.num_devices, dryrun=args.dryrun)

    tcost = time() - tstart
    print("=============================================================")
    if tcost <= 3*60:
        print("Total elapsed time: %.1f [sec]" % tcost)
    else:
        print("Total elapsed time: %.1f [min]" % (tcost/60))


if __name__ == "__main__":
    main()