-
Notifications
You must be signed in to change notification settings - Fork 1
/
arkimaps.1
232 lines (225 loc) · 5.84 KB
/
arkimaps.1
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
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.48.1.
.TH ARKIMAPS "1" "October 2021" "arkimaps 1.0" "User Commands"
.SH NAME
arkimaps \- arkimaps
.SH DESCRIPTION
usage: arkimaps [\-h] [\-v] [\-\-debug] [\-\-version]
.IP
{process,print\-arki\-query,document\-recipes,dispatch,render,preview,dump\-recipes}
\&...
.PP
Render maps from model output.
.SS "positional arguments:"
.TP
{process,print\-arki\-query,document\-recipes,dispatch,render,preview,dump\-recipes}
sub\-command help
.TP
process
draw maps based on GRIB data
.TP
print\-arki\-query
print an arkimet query to query data that can be used
by the recipes found
.TP
document\-recipes
generate recipes documentation
.TP
dispatch
do not render: dispatch into a working directory
.TP
render
render data that was already dispatched
.TP
preview
generate the given product only, and display it with
xdg\-open
.TP
dump\-recipes
dump content parsed from recipes directory
.SS "optional arguments:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
verbose output
.TP
\fB\-\-version\fR
show program's version number and exit
.SH PROCESS SUBCOMMAND
usage: arkimaps process [\-h] [\-\-filter {arkimet|eccodes}] [\-\-grib]
.TP
[\-\-styles dir] [\-\-output file.tar]
[\-\-flavours FLAVOURS] [\-\-recipes dir] [\-\-workdir dir]
.SS "optional arguments:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-filter\fR {arkimet|eccodes}
backend to use to organise data into recipe inputs.
Default: arkimet
.TP
\fB\-\-grib\fR
read input as GRIB data instead of arkimet output.
Implies \fB\-\-filter\fR=\fI\,eccodes\/\fR
.TP
\fB\-\-styles\fR dir
styles directory. Default: ./styles (if existing) or
\fI\,/usr/share/magics/styles/ecmwf\/\fP
.TP
\fB\-\-output\fR file.tar, \fB\-o\fR file.tar
write rendered output to the given file. Default:
write to stdout
.TP
\fB\-\-flavours\fR FLAVOURS
comma\-separated list of flavours to render. Default:
"default"
.TP
\fB\-\-recipes\fR dir
directory with the YAML recipes (default: ./recipes
(if existing) or \fI\,/usr/share/arkimaps/recipes\/\fP
.TP
\fB\-\-workdir\fR dir
working directory. Default: a temporary one
.SH PRINT-ARKI-QUERY SUBCOMMAND
usage: arkimaps print\-arki\-query [\-h] [\-\-recipes dir]
.SS "optional arguments:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-recipes\fR dir
directory with the YAML recipes (default: ./recipes (if
existing) or \fI\,/usr/share/arkimaps/recipes\/\fP
.SH DOCUMENT-RECIPES SUBCOMMAND
usage: arkimaps document\-recipes [\-h] [\-\-recipes dir] [\-\-destdir dir]
.SS "optional arguments:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-recipes\fR dir
directory with the YAML recipes (default: ./recipes (if
existing) or \fI\,/usr/share/arkimaps/recipes\/\fP
.TP
\fB\-\-destdir\fR dir
directory where documentation is written. It defaults to the
recipes directory
.SH DISPATCH SUBCOMMAND
usage: arkimaps dispatch [\-h] [\-\-filter {arkimet|eccodes}] [\-\-grib]
.TP
.SH "\-\-RECIPES DIR"
dir
.SS "positional arguments:"
.TP
dir
working directory
.SS "optional arguments:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-filter\fR {arkimet|eccodes}
backend to use to organise data into recipe inputs.
Default: arkimet
.TP
\fB\-\-grib\fR
read input as GRIB data instead of arkimet output.
Implies \fB\-\-filter\fR=\fI\,eccodes\/\fR
.TP
\fB\-\-recipes\fR dir
directory with the YAML recipes (default: ./recipes
(if existing) or \fI\,/usr/share/arkimaps/recipes\/\fP
.SH RENDER SUBCOMMAND
usage: arkimaps render [\-h] [\-\-filter {arkimet|eccodes}] [\-\-grib]
.TP
[\-\-styles dir] [\-\-output file.tar]
[\-\-flavours FLAVOURS] [\-\-recipes dir]
dir
.SS "positional arguments:"
.TP
dir
working directory
.SS "optional arguments:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-filter\fR {arkimet|eccodes}
backend to use to organise data into recipe inputs.
Default: arkimet
.TP
\fB\-\-grib\fR
read input as GRIB data instead of arkimet output.
Implies \fB\-\-filter\fR=\fI\,eccodes\/\fR
.TP
\fB\-\-styles\fR dir
styles directory. Default: ./styles (if existing) or
\fI\,/usr/share/magics/styles/ecmwf\/\fP
.TP
\fB\-\-output\fR file.tar, \fB\-o\fR file.tar
write rendered output to the given file. Default:
write to stdout
.TP
\fB\-\-flavours\fR FLAVOURS
comma\-separated list of flavours to render. Default:
"default"
.TP
\fB\-\-recipes\fR dir
directory with the YAML recipes (default: ./recipes
(if existing) or \fI\,/usr/share/arkimaps/recipes\/\fP
.SH PREVIEW SUBCOMMAND
usage: arkimaps preview [\-h] [\-\-filter {arkimet|eccodes}] [\-\-grib]
.TP
[\-\-styles dir] [\-\-output file.tar]
[\-\-flavours FLAVOURS] [\-\-recipes dir]
dir prod+step
.SS "positional arguments:"
.TP
dir
working directory
.TP
prod+step
name of the product to preview
.SS "optional arguments:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-filter\fR {arkimet|eccodes}
backend to use to organise data into recipe inputs.
Default: arkimet
.TP
\fB\-\-grib\fR
read input as GRIB data instead of arkimet output.
Implies \fB\-\-filter\fR=\fI\,eccodes\/\fR
.TP
\fB\-\-styles\fR dir
styles directory. Default: ./styles (if existing) or
\fI\,/usr/share/magics/styles/ecmwf\/\fP
.TP
\fB\-\-output\fR file.tar, \fB\-o\fR file.tar
write rendered output to the given file. Default:
write to stdout
.TP
\fB\-\-flavours\fR FLAVOURS
comma\-separated list of flavours to render. Default:
"default"
.TP
\fB\-\-recipes\fR dir
directory with the YAML recipes (default: ./recipes
(if existing) or \fI\,/usr/share/arkimaps/recipes\/\fP
.SH DUMP-RECIPES SUBCOMMAND
usage: arkimaps dump\-recipes [\-h] [\-\-recipes dir]
.SS "optional arguments:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-recipes\fR dir
directory with the YAML recipes (default: ./recipes (if
existing) or \fI\,/usr/share/arkimaps/recipes\/\fP