run_gms.py 11.1 KB
Newer Older
1
2
# -*- coding: utf-8 -*-
__author__ = 'Daniel Scheffler'
3

4
5
import argparse
import warnings
6
import os
7

8
import matplotlib
9

10
matplotlib.use('Agg', warn=False)  # switch matplotlib backend to 'Agg' and disable warning in case its already 'Agg'
11

12
13
from gms_preprocessing import process_controller, __version__  # noqa: E402
from gms_preprocessing.misc.database_tools import GMS_JOB  # noqa: E402
14
15
16
17
18
19
20
from gms_preprocessing.options.config import get_conn_database  # noqa: E402
from gms_preprocessing.options.config import path_options_default  # noqa: E402
from gms_preprocessing.options.config import get_options  # noqa: E402

options_default = get_options(path_options_default, validation=True)  # type: dict


21
22
def parsedArgs_to_user_opts(cli_args):
    return {k: v for k, v in vars(cli_args).items() if not k.startswith('_') and k != 'func'}
23
24


25
def run_from_jobid(args):
26
27
28
29
30
    # TODO distinguish between ID of a master, processing or download job
    # TODO master: find corresponding sub-jobs and run them
    # TODO processing: check for not downloaded scenes and run processing after download
    # TODO download: run only the downloader

31
    # set up process controller instance
32
    kwargs = parsedArgs_to_user_opts(args)
33

34
    if 'GMS_IS_TEST' in os.environ and os.environ['GMS_IS_TEST'] == 'True':
35
36
37
38
39
40
        kwargs['is_test'] = True

    PC = process_controller(args.jobid, **kwargs)

    # run the job
    if 'GMS_IS_TEST_CONFIG' in os.environ and os.environ['GMS_IS_TEST_CONFIG'] == 'True':
41
42
43
44
45
        # in case of software test, it is enough to get an instance of process controller because all inputs are
        # validated within options.config.Job_Config (indirectly called by ProcessController.__init__() )
        pass
    else:
        PC.run_all_processors()
46

47
48
49

def run_from_sceneids(args):
    # create and run a download job
50
    warnings.warn('Currently the console argument parser expects the given scenes as already downloaded.')  # TODO
51
52

    # create a new processing job from scene IDs
53
    dbJob = GMS_JOB(get_conn_database(args.db_host))
54
    dbJob.from_sceneIDlist(list_sceneIDs=args.sceneids,
55
56
57
                           virtual_sensor_id=args.virtual_sensor_id,
                           datasetid_spatial_ref=args.datasetid_spatial_ref,
                           comment=args.comment)
58
    _run_job(dbJob, **parsedArgs_to_user_opts(args))
59
60
61


def run_from_entityids(args):
62
    """Create a new job from entity IDs.
63

64
65
66
    :param args:
    :return:
    """
67
    dbJob = GMS_JOB(get_conn_database(args.db_host))
68
    dbJob.from_entityIDlist(list_entityids=args.entityids,
69
70
71
                            virtual_sensor_id=args.virtual_sensor_id,
                            datasetid_spatial_ref=args.datasetid_spatial_ref,
                            comment=args.comment)
72
    _run_job(dbJob, **parsedArgs_to_user_opts(args))
73
74
75


def run_from_filenames(args):
76
    """Create a new GMS job from filenames of downloaded archives and run it!
77

78
79
80
    :param args:
    :return:
    """
81
    dbJob = GMS_JOB(get_conn_database(args.db_host))
82
    dbJob.from_filenames(list_filenames=args.filenames,
83
84
85
                         virtual_sensor_id=args.virtual_sensor_id,
                         datasetid_spatial_ref=args.datasetid_spatial_ref,
                         comment=args.comment)
86
    _run_job(dbJob, **parsedArgs_to_user_opts(args))
87
88
89
90
91


def run_from_constraints(args):
    # create a new job from constraints
    # TODO
92
93
94
    raise NotImplementedError


95
def _run_job(dbJob, **config_kwargs):
96
97
    # type: (GMS_JOB) -> None
    """
98

99
100
101
    :param dbJob:
    :return:
    """
102
    # create a database record for the given job
103
    dbJob.create()
104
105

    # set up process controller instance
106
107
108
    if 'GMS_IS_TEST' in os.environ and os.environ['GMS_IS_TEST'] == 'True':
        config_kwargs['is_test'] = True

109
    PC = process_controller(dbJob.id, **config_kwargs)
110
111

    # run the job
112
    if 'GMS_IS_TEST_CONFIG' in os.environ and os.environ['GMS_IS_TEST_CONFIG'] == 'True':
113
114
115
116
117
        # in case of software test, it is enough to get an instance of process controller because all inputs are
        # validated within options.config.Job_Config (indirectly called by ProcessController.__init__() )
        pass
    else:
        PC.run_all_processors()
118
119


120
121
def get_gms_argparser():
    """Return argument parser for run_gms.py program."""
122

123
124
125
126
    ##################################################################
    # CONFIGURE MAIN PARSER FOR THE GEOMULTISENS PREPROCESSING CHAIN #
    ##################################################################

127
128
    parser = argparse.ArgumentParser(
        prog='run_gms.py',
129
130
        description='=' * 70 + '\n' + 'GeoMultiSens preprocessing console argument parser. '
                                      'Python implementation by Daniel Scheffler (daniel.scheffler@gfz-potsdam.de)',
131
        epilog="The argument parser offers multiple sub-argument parsers (jobid, sceneids, ...) for starting GMS jobs. "
132
133
               "use '>>> python /path/to/gms_preprocessing/run_gms.py <sub-parser> -h' for detailed documentation and "
               "usage hints.")
134
135
136

    parser.add_argument('--version', action='version', version=__version__)

137
138
139
140
141
142
143
144
145
146
147
148
    #################################################################
    # CONFIGURE SUBPARSERS FOR THE GEOMULTISENS PREPROCESSING CHAIN #
    #################################################################

    ##############################################
    # define parsers containing common arguments #
    ##############################################

    general_opts_parser = argparse.ArgumentParser(add_help=False)
    gop_p = general_opts_parser.add_argument

    gop_p('-jc', '--json_config', nargs='?', type=str,
149
          help='file path of a JSON file containing options. See here for an example: '
150
151
               'https://gitext.gfz-potsdam.de/geomultisens/gms_preprocessing/'
               'blob/master/gms_preprocessing/options/options_default.json')
152

153
154
    # '-exec_L1AP': dict(nargs=3, type=bool, help="L1A Processor configuration",
    #                   metavar=tuple("[run processor, write output, delete output]".split(' ')), default=[1, 1, 1]),
155

156
    gop_p('-DH', '--db_host', nargs='?', type=str,
157
          default='localhost',  # hardcoded here because default json is read from database and host must be available
158
          help='host name of the server that runs the postgreSQL database')
159

160
161
162
163
    gop_p('-DOO', '--delete_old_output', nargs='?', type=bool,
          default=options_default["global_opts"]["delete_old_output"],
          help='delete previously created output of the given job ID before running the job')

164
165
166
    gop_p('-vid', '--virtual_sensor_id', type=int,
          default=options_default["usecase"]["virtual_sensor_id"],
          help='ID of the target (virtual) sensor')
167

168
169
170
    gop_p('-dsid_spat', '--datasetid_spatial_ref', type=int,
          default=options_default["usecase"]["datasetid_spatial_ref"],
          help='dataset ID of the spatial reference')
171

172
173
174
175
    gop_p('--CPUs', type=int,
          default=options_default["global_opts"]["CPUs"],
          help='number of CPU cores to be used for processing (default: "None" -> use all available')

176
177
178
    gop_p('-c', '--comment', nargs='?', type=str,
          default='',
          help='comment concerning the job')
179

180
181
182
183
184
185
186
187
188
    ##################
    # add subparsers #
    ##################

    subparsers = parser.add_subparsers()

    parser_jobid = subparsers.add_parser(
        'jobid', parents=[general_opts_parser],
        description='Run a GeoMultiSens preprocessing job using an already existing job ID.',
189
190
        help="Run a GeoMultiSens preprocessing job using an already existing job ID (Sub-Parser).",
        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
191
192
193
194

    parser_sceneids = subparsers.add_parser(
        'sceneids', parents=[general_opts_parser],
        description='Run a GeoMultiSens preprocessing job for a given list of scene IDs.',
195
196
        help="Run a GeoMultiSens preprocessing job for a given list of scene IDs (Sub-Parser).",
        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
197
198
199
200

    parser_entityids = subparsers.add_parser(
        'entityids', parents=[general_opts_parser],
        description='Run a GeoMultiSens preprocessing job for a given list of entity IDs.',
201
202
        help="Run a GeoMultiSens preprocessing job for a given list of entity IDs (Sub-Parser).",
        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
203
204
205
206
207
208

    parser_filenames = subparsers.add_parser(
        'filenames', parents=[general_opts_parser],
        description='Run a GeoMultiSens preprocessing job for a given list of filenames of '
                    'downloaded satellite image archives!',
        help="Run a GeoMultiSens preprocessing job for a given list of filenames of downloaded satellite "
209
             "image archives! (Sub-Parser).",
210
        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
211
212
213
214

    parser_constraints = subparsers.add_parser(
        'constraints', parents=[general_opts_parser],
        description='Run a GeoMultiSens preprocessing job matching the given constraints.',
215
216
        help="Run a GeoMultiSens preprocessing job matching the given constraints (Sub-Parser).",
        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
217
218
219
220
221
222
223
224

    #################
    # ADD ARGUMENTS #
    #################

    ##########################
    # add indivial arguments #
    ##########################
225

226
227
    # add arguments to parser_jobid
    jid_p = parser_jobid.add_argument
228
229
    jid_p('jobid', type=int, help='job ID of an already created GeoMultiSens preprocessing job '
                                  '(must be present in the jobs table of the database)')
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250

    # add arguments to parser_sceneids
    sid_p = parser_sceneids.add_argument
    sid_p('sceneids', nargs='+', type=int,
          help="list of scene IDs corresponding to valid records within the 'scenes' table of the database")

    # add arguments to parser_entityids
    eid_p = parser_entityids.add_argument
    eid_p('entityids', nargs='+', type=str,
          help="list of entity IDs corresponding to valid records within the 'scenes' table of the database")
    # FIXME satellite and sensor are required

    # add arguments to parser_filenames
    eid_p = parser_filenames.add_argument
    eid_p('filenames', nargs='+', type=str,
          help="list of filenames of satellite image archives corresponding to valid records within the 'scenes' "
               "table of the database")

    # add arguments to parse_constraints
    con_p = parser_constraints.add_argument
    # TODO
251
    # con_p('constraints', nargs='+', type=str, help="list of entity IDs corresponding to valid records within the "
252
    #                                            "'scenes' table of the database")
253

254
255
256
257
    #################################
    # LINK PARSERS TO RUN FUNCTIONS #
    #################################

258
259
260
    parser_jobid.set_defaults(func=run_from_jobid)
    parser_sceneids.set_defaults(func=run_from_sceneids)
    parser_entityids.set_defaults(func=run_from_entityids)
261
    parser_filenames.set_defaults(func=run_from_filenames)
262
    parser_constraints.set_defaults(func=run_from_constraints)
263

264
265
266
    return parser


267
if __name__ == '__main__':
268
    parsed_args = get_gms_argparser().parse_args()
269
270
    parsed_args.func(parsed_args)

271
    print('\nready.')