/
cli.py
378 lines (331 loc) · 13.3 KB
/
cli.py
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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
import asyncio
from functools import partial
import json
import logging
from pathlib import Path
import signal
import sys
import click
import pandas as pd
import requests
import sentry_sdk
from solarforecastarbiter import __version__
from solarforecastarbiter.io import nwp
from solarforecastarbiter.io.api import request_cli_access_token, APISession
from solarforecastarbiter.io.fetch import start_cluster
from solarforecastarbiter.io.reference_observations import reference_data
from solarforecastarbiter.io.utils import mock_raw_report_endpoints
import solarforecastarbiter.reference_forecasts.main as reference_forecasts
from solarforecastarbiter.validation import tasks as validation_tasks
import solarforecastarbiter.reports.main as reports
from solarforecastarbiter.reports import template
CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])
logger = logging.getLogger(__name__)
logging.basicConfig(format='%(asctime)s %(levelname)s %(message)s',
level=logging.WARNING)
sentry_sdk.init(send_default_pii=False,
release=f'solarforecastarbiter-core@{__version__}')
midnight = pd.Timestamp.utcnow().floor('1d')
def handle_exception(exc_type, exc_value, exc_traceback): # pragma: no cover
if issubclass(exc_type, KeyboardInterrupt):
sys.__excepthook__(exc_type, exc_value, exc_traceback)
return
logging.error("Uncaught exception",
exc_info=(exc_type, exc_value, exc_traceback))
sys.excepthook = handle_exception
def cli_access_token(user, password):
try:
token = request_cli_access_token(user, password)
except requests.HTTPError as e:
click.echo(click.style(
e.response.json()['error_description'], fg='red'))
sys.exit(1)
else:
return token
def set_log_level(verbose):
if verbose == 1:
loglevel = 'INFO'
elif verbose > 1:
loglevel = 'DEBUG'
else:
loglevel = 'WARNING'
logging.getLogger().setLevel(loglevel)
class UTCTimestamp(click.ParamType):
"""Convert a timestamp string to a Pandas Timestamp localized to UTC"""
name = 'UTCTimestamp'
def convert(self, value, param, ctx):
try:
out = pd.Timestamp(value)
except ValueError:
self.fail('%s cannot be converted into a Pandas.Timestamp'
% value, param, ctx)
else:
if out.tzinfo:
return out.tz_convert('UTC')
else:
return out.tz_localize('UTC')
UTCTIMESTAMP = UTCTimestamp()
def common_options(cmd):
"""Combine common options into one decorator"""
def wrapper(f):
decs = [
click.option('-v', '--verbose', count=True,
help='Increase logging verbosity'),
click.option('-u', '--user', show_envvar=True,
help='Username to access API.',
envvar='SFA_API_USER',
required=True),
click.option('-p', '--password', show_envvar=True,
envvar='SFA_API_PASSWORD',
required=True,
prompt=True, hide_input=True,
help='Password to access API'),
click.option('--base-url', show_default=True,
envvar='SFA_API_BASE_URL',
show_envvar=True,
default='https://api.solarforecastarbiter.org',
help='URL of the SolarForecastArbiter API')
]
for dec in reversed(decs):
f = dec(f)
return f
return wrapper(cmd)
@click.group(context_settings=CONTEXT_SETTINGS)
@click.version_option(__version__)
def cli():
"""
The SolarForecastArbiter core command line tool
"""
pass # pragma: no cover
@cli.command()
@common_options
@click.option('--start', show_default='00:00:00 Yesterday (UTC)',
type=UTCTIMESTAMP,
default=lambda: midnight - pd.Timedelta(days=1),
help='datetime to start validation at')
@click.option('--end', default=lambda: midnight,
type=UTCTIMESTAMP,
show_default='00:00:00 Today (UTC)',
help='datetime to end validation at')
@click.option(
'--only-missing/--not-only-missing',
is_flag=True, default=True,
help='Only apply validation to periods where daily validation is missing')
@click.argument('observation_id', nargs=-1)
def validate(verbose, user, password, start, end, base_url,
only_missing, observation_id):
"""
Run the validation tasks for a given set of observations
"""
set_log_level(verbose)
token = cli_access_token(user, password)
if not observation_id:
logger.info(
('Validating observation data from %s to %s for all '
'observations'), start, end)
validation_tasks.fetch_and_validate_all_observations(
token, start, end, only_missing=only_missing,
base_url=base_url)
else:
logger.info(
('Validating observation data from %s to %s for '
'observations:\n\t%s'), start, end, ','.join(observation_id))
for obsid in observation_id:
validation_tasks.fetch_and_validate_observation(
token, obsid, start, end, only_missing=only_missing,
base_url=base_url)
@cli.group(help=reference_data.CLI_DESCRIPTION)
def referencedata():
pass # pragma: no cover
network_opt = click.option(
'--network', multiple=True,
help="The networks to act on. Defaults to all.",
default=reference_data.NETWORK_OPTIONS,
type=click.Choice(reference_data.NETWORK_OPTIONS))
@referencedata.command(name='init')
@common_options
@network_opt
@click.option(
'--site-file', type=click.Path(exists=True, resolve_path=True),
default=reference_data.DEFAULT_SITEFILE,
help='The file from which to load all of the reference site metadata.')
def referencedata_init(verbose, user, password, base_url, network, site_file):
"""
Creates sites and observations from a site file.
"""
set_log_level(verbose)
token = cli_access_token(user, password)
# click checks if path exists
all_sites = pd.read_csv(site_file, comment='#')
network_filtered_sites = all_sites[all_sites['network'].isin(network)]
site_dictionaries = reference_data.site_df_to_dicts(network_filtered_sites)
reference_data.initialize_reference_metadata_objects(
token, site_dictionaries, base_url)
@referencedata.command(name='update')
@common_options
@network_opt
@click.option('--end', type=UTCTIMESTAMP,
help='End time (ISO8601) to fetch data for. Default is now')
@click.option('--start', type=UTCTIMESTAMP,
help=('Start time (ISO8601) to fetch data for. Default is'
' max of last timestamp in API and end - 7 days'))
def referencedata_update(verbose, user, password, base_url, network, start,
end):
"""
Updates reference data for the given period.
"""
set_log_level(verbose)
token = cli_access_token(user, password)
reference_data.update_reference_observations(token, start, end, network,
base_url)
@cli.command()
@click.option('-v', '--verbose', count=True,
help='Increase logging verbosity')
@click.option('--chunksize', default=128,
help='Size of a chunk (in KB) to save at one time')
@click.option('--once', is_flag=True,
help='Only get one forecast initialization time')
@click.option('--use-tmp', is_flag=True,
help='Save grib files to /tmp')
@click.option('--netcdf-only', is_flag=True,
help='Only convert files at save_directory to netcdf')
@click.option('--workers', type=int, default=1,
help='Number of worker processes')
@click.argument('save_directory', type=click.Path(
exists=True, writable=True, resolve_path=True, file_okay=False))
@click.argument('model', type=click.Choice([
'gfs_0p25', 'nam_12km', 'rap', 'hrrr_hourly', 'hrrr_subhourly', 'gefs']))
def fetchnwp(verbose, chunksize, once, use_tmp, netcdf_only, workers,
save_directory, model):
"""
Retrieve weather forecasts with variables relevant to solar power
from the NCEP NOMADS server. The utility function wgrib2 is
required to convert these forecasts into netCDF format.
"""
set_log_level(verbose)
from solarforecastarbiter.io.fetch import nwp
nwp.check_wgrib2()
start_cluster(workers, 4)
basepath = Path(save_directory)
if netcdf_only:
path_to_files = basepath
if (
not path_to_files.is_dir() or
len(list(path_to_files.glob('*.grib2'))) == 0
):
logger.error('%s is not a valid directory with grib files',
path_to_files)
sys.exit(1)
fut = asyncio.ensure_future(nwp.optimize_only(path_to_files, model))
else:
logger.info('Fetching NWP forecasts for %s', model)
fut = asyncio.ensure_future(nwp.run(basepath, model, chunksize,
once, use_tmp))
loop = asyncio.get_event_loop()
def bail(ecode):
fut.cancel()
sys.exit(ecode)
loop.add_signal_handler(signal.SIGUSR1, partial(bail, 1))
for sig in (signal.SIGINT, signal.SIGTERM):
loop.add_signal_handler(sig, partial(bail, 0))
loop.run_until_complete(fut)
@cli.command()
@common_options
@click.option('--run-time', type=UTCTIMESTAMP,
help='Run time for the forecasts',
show_default='now',
default=pd.Timestamp.utcnow())
@click.option('--issue-time-buffer', type=str,
help=('Max time-delta between the run time and next '
'initialization time'),
show_default=True,
default='10min')
@click.argument('nwp_directory', type=click.Path(
exists=True, resolve_path=True, file_okay=False),
required=False)
def referencenwp(verbose, user, password, base_url, run_time,
issue_time_buffer, nwp_directory):
"""
Make the reference NWP forecasts that should be issued around run_time
"""
set_log_level(verbose)
token = cli_access_token(user, password)
issue_buffer = pd.Timedelta(issue_time_buffer)
nwp.set_base_path(nwp_directory)
reference_forecasts.make_latest_nwp_forecasts(
token, run_time, issue_buffer, base_url)
@cli.command()
@common_options
@click.option(
'--format', default='detect',
help=('Format of output file. "detect" tries to infer from '
'the file extension of OUTPUT-FILE'),
type=click.Choice(['detect', 'pdf', 'html'], case_sensitive=False)
)
@click.option(
'--serialization-roundtrip', is_flag=True,
help='Run the raw report through a mock API with serialization'
)
@click.option(
'--orca-server-url', help=(
'URL to the plotly orca server to generate PDF images if '
'orca is not installed locally')
)
@click.argument(
'report-file', type=click.Path(exists=True, resolve_path=True))
@click.argument(
'output-file', type=click.Path(resolve_path=True))
def report(verbose, user, password, base_url, report_file, output_file,
format, serialization_roundtrip, orca_server_url):
"""
Make a report. See API documentation's POST reports section for
REPORT_FILE requirements.
"""
set_log_level(verbose)
token = cli_access_token(user, password)
with open(report_file) as f:
metadata = json.load(f)
session = APISession(token, base_url=base_url)
report = session.process_report_dict(metadata)
if orca_server_url is not None:
import plotly.io as pio
pio.orca.config.server_url = orca_server_url
if serialization_roundtrip:
with mock_raw_report_endpoints(base_url):
session.create_report(report)
reports.compute_report(token, 'no_id', base_url)
full_report = session.get_report('no_id')
else:
data = reports.get_data_for_report(session, report)
raw_report = reports.create_raw_report_from_data(report, data)
full_report = report.replace(raw_report=raw_report, status='complete')
# assumed dashboard url based on api url
dash_url = base_url.replace('api', 'dashboard')
if (
(format == 'detect' and output_file.endswith('.html'))
or format == 'html'
):
html_report = template.render_html(
full_report, dash_url,
with_timeseries=True, body_only=False)
with open(output_file, 'w') as f:
f.write(html_report)
elif (
(format == 'detect' and output_file.endswith('.pdf'))
or format == 'pdf'
):
pdf_report = template.render_pdf(full_report, dash_url)
with open(output_file, 'wb') as f:
f.write(pdf_report)
else:
raise ValueError("Unable to detect format")
@cli.command(context_settings=dict(ignore_unknown_options=True))
@click.argument('pytest_args', nargs=-1, type=click.UNPROCESSED)
def test(pytest_args): # pragma: no cover
"""Test this installation of solarforecastarbiter"""
import pytest
ret_code = pytest.main(
['--pyargs', 'solarforecastarbiter'] + list(pytest_args))
sys.exit(ret_code)
if __name__ == "__main__": # pragma: no cover
cli()