1 | %% Generated by Sphinx. |
---|
2 | \def\sphinxdocclass{report} |
---|
3 | \documentclass[letterpaper,10pt,english]{sphinxmanual} |
---|
4 | \ifdefined\pdfpxdimen |
---|
5 | \let\sphinxpxdimen\pdfpxdimen\else\newdimen\sphinxpxdimen |
---|
6 | \fi \sphinxpxdimen=.75bp\relax |
---|
7 | |
---|
8 | \PassOptionsToPackage{warn}{textcomp} |
---|
9 | \usepackage[utf8]{inputenc} |
---|
10 | \ifdefined\DeclareUnicodeCharacter |
---|
11 | % support both utf8 and utf8x syntaxes |
---|
12 | \edef\sphinxdqmaybe{\ifdefined\DeclareUnicodeCharacterAsOptional\string"\fi} |
---|
13 | \DeclareUnicodeCharacter{\sphinxdqmaybe00A0}{\nobreakspace} |
---|
14 | \DeclareUnicodeCharacter{\sphinxdqmaybe2500}{\sphinxunichar{2500}} |
---|
15 | \DeclareUnicodeCharacter{\sphinxdqmaybe2502}{\sphinxunichar{2502}} |
---|
16 | \DeclareUnicodeCharacter{\sphinxdqmaybe2514}{\sphinxunichar{2514}} |
---|
17 | \DeclareUnicodeCharacter{\sphinxdqmaybe251C}{\sphinxunichar{251C}} |
---|
18 | \DeclareUnicodeCharacter{\sphinxdqmaybe2572}{\textbackslash} |
---|
19 | \fi |
---|
20 | \usepackage{cmap} |
---|
21 | \usepackage[T1]{fontenc} |
---|
22 | \usepackage{amsmath,amssymb,amstext} |
---|
23 | \usepackage{babel} |
---|
24 | \usepackage{times} |
---|
25 | \usepackage[Bjarne]{fncychap} |
---|
26 | \usepackage{sphinx} |
---|
27 | |
---|
28 | \fvset{fontsize=\small} |
---|
29 | \usepackage{geometry} |
---|
30 | |
---|
31 | % Include hyperref last. |
---|
32 | \usepackage{hyperref} |
---|
33 | % Fix anchor placement for figures with captions. |
---|
34 | \usepackage{hypcap}% it must be loaded after hyperref. |
---|
35 | % Set up styles of URL: it should be placed after hyperref. |
---|
36 | \urlstyle{same} |
---|
37 | \addto\captionsenglish{\renewcommand{\contentsname}{Table of Contents:}} |
---|
38 | |
---|
39 | \addto\captionsenglish{\renewcommand{\figurename}{Fig.\@ }} |
---|
40 | \makeatletter |
---|
41 | \def\fnum@figure{\figurename\thefigure{}} |
---|
42 | \makeatother |
---|
43 | \addto\captionsenglish{\renewcommand{\tablename}{Table }} |
---|
44 | \makeatletter |
---|
45 | \def\fnum@table{\tablename\thetable{}} |
---|
46 | \makeatother |
---|
47 | \addto\captionsenglish{\renewcommand{\literalblockname}{Listing}} |
---|
48 | |
---|
49 | \addto\captionsenglish{\renewcommand{\literalblockcontinuedname}{continued from previous page}} |
---|
50 | \addto\captionsenglish{\renewcommand{\literalblockcontinuesname}{continues on next page}} |
---|
51 | \addto\captionsenglish{\renewcommand{\sphinxnonalphabeticalgroupname}{Non-alphabetical}} |
---|
52 | \addto\captionsenglish{\renewcommand{\sphinxsymbolsname}{Symbols}} |
---|
53 | \addto\captionsenglish{\renewcommand{\sphinxnumbersname}{Numbers}} |
---|
54 | |
---|
55 | \addto\extrasenglish{\def\pageautorefname{page}} |
---|
56 | |
---|
57 | \setcounter{tocdepth}{2} |
---|
58 | |
---|
59 | |
---|
60 | |
---|
61 | \title{flex\_extract Documentation} |
---|
62 | \date{Mar 07, 2019} |
---|
63 | \release{7.1 alpha} |
---|
64 | \author{Anne Philipp and Leopold Haimberger} |
---|
65 | \newcommand{\sphinxlogo}{\vbox{}} |
---|
66 | \renewcommand{\releasename}{Release} |
---|
67 | \makeindex |
---|
68 | \begin{document} |
---|
69 | |
---|
70 | \pagestyle{empty} |
---|
71 | \sphinxmaketitle |
---|
72 | \pagestyle{plain} |
---|
73 | \sphinxtableofcontents |
---|
74 | \pagestyle{normal} |
---|
75 | \phantomsection\label{\detokenize{index::doc}} |
---|
76 | |
---|
77 | |
---|
78 | flex\_extract is a software to retrieve meteorological fields from the European Centre for Medium-Range Weather Forecasts (ECMWF) Mars archive to server as input files for the FLEXTRA/FLEXPART Atmospheric Transport Modelling system. |
---|
79 | |
---|
80 | All third-party software and libraries required by flex\_extract are open source and free of charge. |
---|
81 | |
---|
82 | |
---|
83 | |
---|
84 | \begin{sphinxadmonition}{note}{Note:} |
---|
85 | !{[}{]}{[}/documentation/Sphinx/source/\_static/cc-by-40.png{]} |
---|
86 | This work is licensed under the Creative Commons Attribution 4.0 |
---|
87 | International License. To view a copy of this license, visit |
---|
88 | \sphinxurl{http://creativecommons.org/licenses/by/4.0/} or send a letter to |
---|
89 | Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. |
---|
90 | \end{sphinxadmonition} |
---|
91 | |
---|
92 | |
---|
93 | \chapter{Downloads} |
---|
94 | \label{\detokenize{downloads:downloads}}\label{\detokenize{downloads::doc}} |
---|
95 | Describe download options of flex\_extract …. |
---|
96 | \begin{quote} |
---|
97 | |
---|
98 | UNDER CONSTRUCTION |
---|
99 | \end{quote} |
---|
100 | |
---|
101 | |
---|
102 | \section{Download tar-balls} |
---|
103 | \label{\detokenize{downloads/tar_balls:download-tar-balls}}\label{\detokenize{downloads/tar_balls::doc}}\begin{quote} |
---|
104 | |
---|
105 | UNDER CONSTRUCTION |
---|
106 | \end{quote} |
---|
107 | |
---|
108 | |
---|
109 | \section{Git Repository} |
---|
110 | \label{\detokenize{downloads/git_repo:git-repository}}\label{\detokenize{downloads/git_repo::doc}}\begin{quote} |
---|
111 | |
---|
112 | UNDER CONSTRUCTION |
---|
113 | \end{quote} |
---|
114 | |
---|
115 | |
---|
116 | \section{History of Changes} |
---|
117 | \label{\detokenize{downloads/history_changes:history-of-changes}}\label{\detokenize{downloads/history_changes::doc}}\begin{quote} |
---|
118 | |
---|
119 | UNDER CONSTRUCTION |
---|
120 | \end{quote} |
---|
121 | |
---|
122 | |
---|
123 | \chapter{Installation} |
---|
124 | \label{\detokenize{installation:installation}}\label{\detokenize{installation::doc}}\begin{quote} |
---|
125 | |
---|
126 | UNDER CONSTRUCTION |
---|
127 | \end{quote} |
---|
128 | |
---|
129 | |
---|
130 | \section{Requirements} |
---|
131 | \label{\detokenize{installation/requirements:requirements}}\label{\detokenize{installation/requirements::doc}}\begin{quote} |
---|
132 | |
---|
133 | UNDER CONSTRUCTION |
---|
134 | \end{quote} |
---|
135 | |
---|
136 | |
---|
137 | \section{Operating modes} |
---|
138 | \label{\detokenize{installation/oper_modes:operating-modes}}\label{\detokenize{installation/oper_modes::doc}}\begin{quote} |
---|
139 | |
---|
140 | UNDER CONSTRUCTION |
---|
141 | \end{quote} |
---|
142 | |
---|
143 | |
---|
144 | \section{Installation test} |
---|
145 | \label{\detokenize{installation/test_install:installation-test}}\label{\detokenize{installation/test_install::doc}}\begin{quote} |
---|
146 | |
---|
147 | UNDER CONSTRUCTION |
---|
148 | \end{quote} |
---|
149 | |
---|
150 | |
---|
151 | \chapter{Program Structure} |
---|
152 | \label{\detokenize{program_structure:program-structure}}\label{\detokenize{program_structure::doc}} |
---|
153 | Describe structure of flex\_extract …. |
---|
154 | \begin{quote} |
---|
155 | |
---|
156 | UNDER CONSTRUCTION |
---|
157 | \end{quote} |
---|
158 | |
---|
159 | |
---|
160 | \section{Program Overview} |
---|
161 | \label{\detokenize{program_structure/prog_overview:program-overview}}\label{\detokenize{program_structure/prog_overview::doc}}\begin{quote} |
---|
162 | |
---|
163 | UNDER CONSTRUCTION |
---|
164 | \end{quote} |
---|
165 | |
---|
166 | |
---|
167 | \section{Program Components} |
---|
168 | \label{\detokenize{program_structure/prog_components:program-components}}\label{\detokenize{program_structure/prog_components::doc}}\begin{quote} |
---|
169 | |
---|
170 | UNDER CONSTRUCTION |
---|
171 | \end{quote} |
---|
172 | |
---|
173 | |
---|
174 | \section{Program Flow} |
---|
175 | \label{\detokenize{program_structure/prog_flow:program-flow}}\label{\detokenize{program_structure/prog_flow::doc}}\begin{quote} |
---|
176 | |
---|
177 | UNDER CONSTRUCTION |
---|
178 | \end{quote} |
---|
179 | |
---|
180 | |
---|
181 | \chapter{User Guide} |
---|
182 | \label{\detokenize{user_guide:user-guide}}\label{\detokenize{user_guide::doc}}\begin{quote} |
---|
183 | |
---|
184 | UNDER CONSTRUCTION |
---|
185 | \end{quote} |
---|
186 | |
---|
187 | |
---|
188 | \section{How to use flex\_extract} |
---|
189 | \label{\detokenize{user_guide/how_to:how-to-use-flex-extract}}\label{\detokenize{user_guide/how_to::doc}}\begin{quote} |
---|
190 | |
---|
191 | UNDER CONSTRUCTION |
---|
192 | \end{quote} |
---|
193 | |
---|
194 | |
---|
195 | \section{CONTROL-file templates} |
---|
196 | \label{\detokenize{user_guide/control_templates:control-file-templates}}\label{\detokenize{user_guide/control_templates::doc}}\begin{quote} |
---|
197 | |
---|
198 | UNDER CONSTRUCTION |
---|
199 | \end{quote} |
---|
200 | |
---|
201 | |
---|
202 | \chapter{Auto Generated Documentation} |
---|
203 | \label{\detokenize{api:auto-generated-documentation}}\label{\detokenize{api::doc}} |
---|
204 | \begin{sphinxShadowBox} |
---|
205 | \begin{itemize} |
---|
206 | \item {} |
---|
207 | \phantomsection\label{\detokenize{api:id1}}{\hyperref[\detokenize{api:porgrams}]{\sphinxcrossref{Porgrams}}} |
---|
208 | \begin{itemize} |
---|
209 | \item {} |
---|
210 | \phantomsection\label{\detokenize{api:id2}}{\hyperref[\detokenize{api:install}]{\sphinxcrossref{install}}} |
---|
211 | |
---|
212 | \item {} |
---|
213 | \phantomsection\label{\detokenize{api:id3}}{\hyperref[\detokenize{api:submit}]{\sphinxcrossref{submit}}} |
---|
214 | |
---|
215 | \end{itemize} |
---|
216 | |
---|
217 | \item {} |
---|
218 | \phantomsection\label{\detokenize{api:id4}}{\hyperref[\detokenize{api:classes}]{\sphinxcrossref{Classes}}} |
---|
219 | \begin{itemize} |
---|
220 | \item {} |
---|
221 | \phantomsection\label{\detokenize{api:id5}}{\hyperref[\detokenize{api:controlfile}]{\sphinxcrossref{ControlFile}}} |
---|
222 | |
---|
223 | \item {} |
---|
224 | \phantomsection\label{\detokenize{api:id6}}{\hyperref[\detokenize{api:ecflexpart}]{\sphinxcrossref{EcFlexpart}}} |
---|
225 | |
---|
226 | \item {} |
---|
227 | \phantomsection\label{\detokenize{api:id7}}{\hyperref[\detokenize{api:gributil}]{\sphinxcrossref{GribUtil}}} |
---|
228 | |
---|
229 | \item {} |
---|
230 | \phantomsection\label{\detokenize{api:id8}}{\hyperref[\detokenize{api:module-MarsRetrieval}]{\sphinxcrossref{MarsRetrieval}}} |
---|
231 | |
---|
232 | \item {} |
---|
233 | \phantomsection\label{\detokenize{api:id9}}{\hyperref[\detokenize{api:uiofiles}]{\sphinxcrossref{UioFiles}}} |
---|
234 | |
---|
235 | \end{itemize} |
---|
236 | |
---|
237 | \item {} |
---|
238 | \phantomsection\label{\detokenize{api:id10}}{\hyperref[\detokenize{api:modules}]{\sphinxcrossref{Modules}}} |
---|
239 | \begin{itemize} |
---|
240 | \item {} |
---|
241 | \phantomsection\label{\detokenize{api:id11}}{\hyperref[\detokenize{api:get-mars-data}]{\sphinxcrossref{get\_mars\_data}}} |
---|
242 | |
---|
243 | \item {} |
---|
244 | \phantomsection\label{\detokenize{api:id12}}{\hyperref[\detokenize{api:prepare-flexpart}]{\sphinxcrossref{prepare\_flexpart}}} |
---|
245 | |
---|
246 | \item {} |
---|
247 | \phantomsection\label{\detokenize{api:id13}}{\hyperref[\detokenize{api:tools}]{\sphinxcrossref{tools}}} |
---|
248 | |
---|
249 | \item {} |
---|
250 | \phantomsection\label{\detokenize{api:id14}}{\hyperref[\detokenize{api:module-disaggregation}]{\sphinxcrossref{disaggregation}}} |
---|
251 | |
---|
252 | \end{itemize} |
---|
253 | |
---|
254 | \end{itemize} |
---|
255 | \end{sphinxShadowBox} |
---|
256 | |
---|
257 | |
---|
258 | \section{Porgrams} |
---|
259 | \label{\detokenize{api:porgrams}} |
---|
260 | |
---|
261 | \subsection{install} |
---|
262 | \label{\detokenize{api:install}} |
---|
263 | |
---|
264 | \subsection{submit} |
---|
265 | \label{\detokenize{api:submit}} |
---|
266 | |
---|
267 | \section{Classes} |
---|
268 | \label{\detokenize{api:classes}} |
---|
269 | |
---|
270 | \subsection{ControlFile} |
---|
271 | \label{\detokenize{api:controlfile}} |
---|
272 | |
---|
273 | \subsection{EcFlexpart} |
---|
274 | \label{\detokenize{api:ecflexpart}} |
---|
275 | |
---|
276 | \subsection{GribUtil} |
---|
277 | \label{\detokenize{api:gributil}} |
---|
278 | |
---|
279 | \subsection{MarsRetrieval} |
---|
280 | \label{\detokenize{api:module-MarsRetrieval}}\label{\detokenize{api:marsretrieval}}\index{MarsRetrieval (module)@\spxentry{MarsRetrieval}\spxextra{module}}\index{MarsRetrieval (class in MarsRetrieval)@\spxentry{MarsRetrieval}\spxextra{class in MarsRetrieval}} |
---|
281 | |
---|
282 | \begin{fulllineitems} |
---|
283 | \phantomsection\label{\detokenize{api:MarsRetrieval.MarsRetrieval}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{MarsRetrieval.}}\sphinxbfcode{\sphinxupquote{MarsRetrieval}}}{\emph{server}, \emph{public}, \emph{marsclass='EA'}, \emph{dataset=''}, \emph{type=''}, \emph{levtype=''}, \emph{levelist=''}, \emph{repres=''}, \emph{date=''}, \emph{resol=''}, \emph{stream=''}, \emph{area=''}, \emph{time=''}, \emph{step=''}, \emph{expver='1'}, \emph{number=''}, \emph{accuracy=''}, \emph{grid=''}, \emph{gaussian=''}, \emph{target=''}, \emph{param=''}}{} |
---|
284 | Specific syntax and content for submission of MARS retrievals. |
---|
285 | |
---|
286 | A MARS revtrieval has a specific syntax with a selection of keywords and |
---|
287 | their corresponding values. This class provides the necessary functions |
---|
288 | by displaying the selected parameters and their values and the actual |
---|
289 | retrievement of the data through a mars request or a Python web api |
---|
290 | interface. The initialization already expects all the keyword values. |
---|
291 | |
---|
292 | A description of MARS keywords/arguments and examples of their |
---|
293 | values can be found here: |
---|
294 | \sphinxurl{https://software.ecmwf.int/wiki/display/UDOC/} Identification+keywords\#Identificationkeywords-class |
---|
295 | \index{server (MarsRetrieval.MarsRetrieval attribute)@\spxentry{server}\spxextra{MarsRetrieval.MarsRetrieval attribute}} |
---|
296 | |
---|
297 | \begin{fulllineitems} |
---|
298 | \phantomsection\label{\detokenize{api:MarsRetrieval.MarsRetrieval.server}}\pysigline{\sphinxbfcode{\sphinxupquote{server}}} |
---|
299 | This is the connection to the ECMWF data servers. |
---|
300 | \begin{quote}\begin{description} |
---|
301 | \item[{Type}] \leavevmode |
---|
302 | ECMWFService or ECMWFDataServer |
---|
303 | |
---|
304 | \end{description}\end{quote} |
---|
305 | |
---|
306 | \end{fulllineitems} |
---|
307 | |
---|
308 | \index{public (MarsRetrieval.MarsRetrieval attribute)@\spxentry{public}\spxextra{MarsRetrieval.MarsRetrieval attribute}} |
---|
309 | |
---|
310 | \begin{fulllineitems} |
---|
311 | \phantomsection\label{\detokenize{api:MarsRetrieval.MarsRetrieval.public}}\pysigline{\sphinxbfcode{\sphinxupquote{public}}} |
---|
312 | Decides which Web API Server version is used. |
---|
313 | \begin{quote}\begin{description} |
---|
314 | \item[{Type}] \leavevmode |
---|
315 | int |
---|
316 | |
---|
317 | \end{description}\end{quote} |
---|
318 | |
---|
319 | \end{fulllineitems} |
---|
320 | |
---|
321 | \index{marsclass (MarsRetrieval.MarsRetrieval attribute)@\spxentry{marsclass}\spxextra{MarsRetrieval.MarsRetrieval attribute}} |
---|
322 | |
---|
323 | \begin{fulllineitems} |
---|
324 | \phantomsection\label{\detokenize{api:MarsRetrieval.MarsRetrieval.marsclass}}\pysigline{\sphinxbfcode{\sphinxupquote{marsclass}}} |
---|
325 | Characterisation of dataset. |
---|
326 | \begin{quote}\begin{description} |
---|
327 | \item[{Type}] \leavevmode |
---|
328 | str, optional |
---|
329 | |
---|
330 | \end{description}\end{quote} |
---|
331 | |
---|
332 | \end{fulllineitems} |
---|
333 | |
---|
334 | \index{dataset (MarsRetrieval.MarsRetrieval attribute)@\spxentry{dataset}\spxextra{MarsRetrieval.MarsRetrieval attribute}} |
---|
335 | |
---|
336 | \begin{fulllineitems} |
---|
337 | \phantomsection\label{\detokenize{api:MarsRetrieval.MarsRetrieval.dataset}}\pysigline{\sphinxbfcode{\sphinxupquote{dataset}}} |
---|
338 | For public datasets there is the specific naming and parameter |
---|
339 | dataset which has to be used to characterize the type of |
---|
340 | data. |
---|
341 | \begin{quote}\begin{description} |
---|
342 | \item[{Type}] \leavevmode |
---|
343 | str, optional |
---|
344 | |
---|
345 | \end{description}\end{quote} |
---|
346 | |
---|
347 | \end{fulllineitems} |
---|
348 | |
---|
349 | \index{type (MarsRetrieval.MarsRetrieval attribute)@\spxentry{type}\spxextra{MarsRetrieval.MarsRetrieval attribute}} |
---|
350 | |
---|
351 | \begin{fulllineitems} |
---|
352 | \phantomsection\label{\detokenize{api:MarsRetrieval.MarsRetrieval.type}}\pysigline{\sphinxbfcode{\sphinxupquote{type}}} |
---|
353 | Determines the type of fields to be retrieved. |
---|
354 | \begin{quote}\begin{description} |
---|
355 | \item[{Type}] \leavevmode |
---|
356 | str, optional |
---|
357 | |
---|
358 | \end{description}\end{quote} |
---|
359 | |
---|
360 | \end{fulllineitems} |
---|
361 | |
---|
362 | \index{levtype (MarsRetrieval.MarsRetrieval attribute)@\spxentry{levtype}\spxextra{MarsRetrieval.MarsRetrieval attribute}} |
---|
363 | |
---|
364 | \begin{fulllineitems} |
---|
365 | \phantomsection\label{\detokenize{api:MarsRetrieval.MarsRetrieval.levtype}}\pysigline{\sphinxbfcode{\sphinxupquote{levtype}}} |
---|
366 | Denotes type of level. |
---|
367 | \begin{quote}\begin{description} |
---|
368 | \item[{Type}] \leavevmode |
---|
369 | str, optional |
---|
370 | |
---|
371 | \end{description}\end{quote} |
---|
372 | |
---|
373 | \end{fulllineitems} |
---|
374 | |
---|
375 | \index{levelist (MarsRetrieval.MarsRetrieval attribute)@\spxentry{levelist}\spxextra{MarsRetrieval.MarsRetrieval attribute}} |
---|
376 | |
---|
377 | \begin{fulllineitems} |
---|
378 | \phantomsection\label{\detokenize{api:MarsRetrieval.MarsRetrieval.levelist}}\pysigline{\sphinxbfcode{\sphinxupquote{levelist}}} |
---|
379 | Specifies the required levels. |
---|
380 | \begin{quote}\begin{description} |
---|
381 | \item[{Type}] \leavevmode |
---|
382 | str, optional |
---|
383 | |
---|
384 | \end{description}\end{quote} |
---|
385 | |
---|
386 | \end{fulllineitems} |
---|
387 | |
---|
388 | \index{repres (MarsRetrieval.MarsRetrieval attribute)@\spxentry{repres}\spxextra{MarsRetrieval.MarsRetrieval attribute}} |
---|
389 | |
---|
390 | \begin{fulllineitems} |
---|
391 | \phantomsection\label{\detokenize{api:MarsRetrieval.MarsRetrieval.repres}}\pysigline{\sphinxbfcode{\sphinxupquote{repres}}} |
---|
392 | Selects the representation of the archived data. |
---|
393 | \begin{quote}\begin{description} |
---|
394 | \item[{Type}] \leavevmode |
---|
395 | str, optional |
---|
396 | |
---|
397 | \end{description}\end{quote} |
---|
398 | |
---|
399 | \end{fulllineitems} |
---|
400 | |
---|
401 | \index{date (MarsRetrieval.MarsRetrieval attribute)@\spxentry{date}\spxextra{MarsRetrieval.MarsRetrieval attribute}} |
---|
402 | |
---|
403 | \begin{fulllineitems} |
---|
404 | \phantomsection\label{\detokenize{api:MarsRetrieval.MarsRetrieval.date}}\pysigline{\sphinxbfcode{\sphinxupquote{date}}} |
---|
405 | Specifies the Analysis date, the Forecast base date or |
---|
406 | Observations date. |
---|
407 | \begin{quote}\begin{description} |
---|
408 | \item[{Type}] \leavevmode |
---|
409 | str, optional |
---|
410 | |
---|
411 | \end{description}\end{quote} |
---|
412 | |
---|
413 | \end{fulllineitems} |
---|
414 | |
---|
415 | \index{resol (MarsRetrieval.MarsRetrieval attribute)@\spxentry{resol}\spxextra{MarsRetrieval.MarsRetrieval attribute}} |
---|
416 | |
---|
417 | \begin{fulllineitems} |
---|
418 | \phantomsection\label{\detokenize{api:MarsRetrieval.MarsRetrieval.resol}}\pysigline{\sphinxbfcode{\sphinxupquote{resol}}} |
---|
419 | Specifies the desired triangular truncation of retrieved data, |
---|
420 | before carrying out any other selected post-processing. |
---|
421 | \begin{quote}\begin{description} |
---|
422 | \item[{Type}] \leavevmode |
---|
423 | str, optional |
---|
424 | |
---|
425 | \end{description}\end{quote} |
---|
426 | |
---|
427 | \end{fulllineitems} |
---|
428 | |
---|
429 | \index{stream (MarsRetrieval.MarsRetrieval attribute)@\spxentry{stream}\spxextra{MarsRetrieval.MarsRetrieval attribute}} |
---|
430 | |
---|
431 | \begin{fulllineitems} |
---|
432 | \phantomsection\label{\detokenize{api:MarsRetrieval.MarsRetrieval.stream}}\pysigline{\sphinxbfcode{\sphinxupquote{stream}}} |
---|
433 | Identifies the forecasting system used to generate the data. |
---|
434 | \begin{quote}\begin{description} |
---|
435 | \item[{Type}] \leavevmode |
---|
436 | str, optional |
---|
437 | |
---|
438 | \end{description}\end{quote} |
---|
439 | |
---|
440 | \end{fulllineitems} |
---|
441 | |
---|
442 | \index{area (MarsRetrieval.MarsRetrieval attribute)@\spxentry{area}\spxextra{MarsRetrieval.MarsRetrieval attribute}} |
---|
443 | |
---|
444 | \begin{fulllineitems} |
---|
445 | \phantomsection\label{\detokenize{api:MarsRetrieval.MarsRetrieval.area}}\pysigline{\sphinxbfcode{\sphinxupquote{area}}} |
---|
446 | Specifies the desired sub-area of data to be extracted. |
---|
447 | \begin{quote}\begin{description} |
---|
448 | \item[{Type}] \leavevmode |
---|
449 | str, optional |
---|
450 | |
---|
451 | \end{description}\end{quote} |
---|
452 | |
---|
453 | \end{fulllineitems} |
---|
454 | |
---|
455 | \index{time (MarsRetrieval.MarsRetrieval attribute)@\spxentry{time}\spxextra{MarsRetrieval.MarsRetrieval attribute}} |
---|
456 | |
---|
457 | \begin{fulllineitems} |
---|
458 | \phantomsection\label{\detokenize{api:MarsRetrieval.MarsRetrieval.time}}\pysigline{\sphinxbfcode{\sphinxupquote{time}}} |
---|
459 | Specifies the time of the data in hours and minutes. |
---|
460 | \begin{quote}\begin{description} |
---|
461 | \item[{Type}] \leavevmode |
---|
462 | str, optional |
---|
463 | |
---|
464 | \end{description}\end{quote} |
---|
465 | |
---|
466 | \end{fulllineitems} |
---|
467 | |
---|
468 | \index{step (MarsRetrieval.MarsRetrieval attribute)@\spxentry{step}\spxextra{MarsRetrieval.MarsRetrieval attribute}} |
---|
469 | |
---|
470 | \begin{fulllineitems} |
---|
471 | \phantomsection\label{\detokenize{api:MarsRetrieval.MarsRetrieval.step}}\pysigline{\sphinxbfcode{\sphinxupquote{step}}} |
---|
472 | Specifies the forecast time step from forecast base time. |
---|
473 | \begin{quote}\begin{description} |
---|
474 | \item[{Type}] \leavevmode |
---|
475 | str, optional |
---|
476 | |
---|
477 | \end{description}\end{quote} |
---|
478 | |
---|
479 | \end{fulllineitems} |
---|
480 | |
---|
481 | \index{expver (MarsRetrieval.MarsRetrieval attribute)@\spxentry{expver}\spxextra{MarsRetrieval.MarsRetrieval attribute}} |
---|
482 | |
---|
483 | \begin{fulllineitems} |
---|
484 | \phantomsection\label{\detokenize{api:MarsRetrieval.MarsRetrieval.expver}}\pysigline{\sphinxbfcode{\sphinxupquote{expver}}} |
---|
485 | The version of the dataset. |
---|
486 | \begin{quote}\begin{description} |
---|
487 | \item[{Type}] \leavevmode |
---|
488 | str, optional |
---|
489 | |
---|
490 | \end{description}\end{quote} |
---|
491 | |
---|
492 | \end{fulllineitems} |
---|
493 | |
---|
494 | \index{number (MarsRetrieval.MarsRetrieval attribute)@\spxentry{number}\spxextra{MarsRetrieval.MarsRetrieval attribute}} |
---|
495 | |
---|
496 | \begin{fulllineitems} |
---|
497 | \phantomsection\label{\detokenize{api:MarsRetrieval.MarsRetrieval.number}}\pysigline{\sphinxbfcode{\sphinxupquote{number}}} |
---|
498 | Selects the member in ensemble forecast run. |
---|
499 | \begin{quote}\begin{description} |
---|
500 | \item[{Type}] \leavevmode |
---|
501 | str, optional |
---|
502 | |
---|
503 | \end{description}\end{quote} |
---|
504 | |
---|
505 | \end{fulllineitems} |
---|
506 | |
---|
507 | \index{accuracy (MarsRetrieval.MarsRetrieval attribute)@\spxentry{accuracy}\spxextra{MarsRetrieval.MarsRetrieval attribute}} |
---|
508 | |
---|
509 | \begin{fulllineitems} |
---|
510 | \phantomsection\label{\detokenize{api:MarsRetrieval.MarsRetrieval.accuracy}}\pysigline{\sphinxbfcode{\sphinxupquote{accuracy}}} |
---|
511 | Specifies the number of bits per value to be used in the |
---|
512 | generated GRIB coded fields. |
---|
513 | \begin{quote}\begin{description} |
---|
514 | \item[{Type}] \leavevmode |
---|
515 | str, optional |
---|
516 | |
---|
517 | \end{description}\end{quote} |
---|
518 | |
---|
519 | \end{fulllineitems} |
---|
520 | |
---|
521 | \index{grid (MarsRetrieval.MarsRetrieval attribute)@\spxentry{grid}\spxextra{MarsRetrieval.MarsRetrieval attribute}} |
---|
522 | |
---|
523 | \begin{fulllineitems} |
---|
524 | \phantomsection\label{\detokenize{api:MarsRetrieval.MarsRetrieval.grid}}\pysigline{\sphinxbfcode{\sphinxupquote{grid}}} |
---|
525 | Specifies the output grid which can be either a Gaussian grid |
---|
526 | or a Latitude/Longitude grid. |
---|
527 | \begin{quote}\begin{description} |
---|
528 | \item[{Type}] \leavevmode |
---|
529 | str, optional |
---|
530 | |
---|
531 | \end{description}\end{quote} |
---|
532 | |
---|
533 | \end{fulllineitems} |
---|
534 | |
---|
535 | \index{gaussian (MarsRetrieval.MarsRetrieval attribute)@\spxentry{gaussian}\spxextra{MarsRetrieval.MarsRetrieval attribute}} |
---|
536 | |
---|
537 | \begin{fulllineitems} |
---|
538 | \phantomsection\label{\detokenize{api:MarsRetrieval.MarsRetrieval.gaussian}}\pysigline{\sphinxbfcode{\sphinxupquote{gaussian}}} |
---|
539 | This parameter is deprecated and should no longer be used. |
---|
540 | Specifies the desired type of Gaussian grid for the output. |
---|
541 | \begin{quote}\begin{description} |
---|
542 | \item[{Type}] \leavevmode |
---|
543 | str, optional |
---|
544 | |
---|
545 | \end{description}\end{quote} |
---|
546 | |
---|
547 | \end{fulllineitems} |
---|
548 | |
---|
549 | \index{target (MarsRetrieval.MarsRetrieval attribute)@\spxentry{target}\spxextra{MarsRetrieval.MarsRetrieval attribute}} |
---|
550 | |
---|
551 | \begin{fulllineitems} |
---|
552 | \phantomsection\label{\detokenize{api:MarsRetrieval.MarsRetrieval.target}}\pysigline{\sphinxbfcode{\sphinxupquote{target}}} |
---|
553 | Specifies a file into which data is to be written after |
---|
554 | retrieval or manipulation. |
---|
555 | \begin{quote}\begin{description} |
---|
556 | \item[{Type}] \leavevmode |
---|
557 | str, optional |
---|
558 | |
---|
559 | \end{description}\end{quote} |
---|
560 | |
---|
561 | \end{fulllineitems} |
---|
562 | |
---|
563 | \index{param (MarsRetrieval.MarsRetrieval attribute)@\spxentry{param}\spxextra{MarsRetrieval.MarsRetrieval attribute}} |
---|
564 | |
---|
565 | \begin{fulllineitems} |
---|
566 | \phantomsection\label{\detokenize{api:MarsRetrieval.MarsRetrieval.param}}\pysigline{\sphinxbfcode{\sphinxupquote{param}}} |
---|
567 | Specifies the meteorological parameter. |
---|
568 | \begin{quote}\begin{description} |
---|
569 | \item[{Type}] \leavevmode |
---|
570 | str, optional |
---|
571 | |
---|
572 | \end{description}\end{quote} |
---|
573 | |
---|
574 | \end{fulllineitems} |
---|
575 | |
---|
576 | \index{data\_retrieve() (MarsRetrieval.MarsRetrieval method)@\spxentry{data\_retrieve()}\spxextra{MarsRetrieval.MarsRetrieval method}} |
---|
577 | |
---|
578 | \begin{fulllineitems} |
---|
579 | \phantomsection\label{\detokenize{api:MarsRetrieval.MarsRetrieval.data_retrieve}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{data\_retrieve}}}{}{} |
---|
580 | Submits a MARS retrieval. Depending on the existence of |
---|
581 | ECMWF Web-API or CDS API it is submitted via Python or a |
---|
582 | subprocess in the Shell. The parameter for the mars retrieval |
---|
583 | are taken from the defined class attributes. |
---|
584 | |
---|
585 | \end{fulllineitems} |
---|
586 | |
---|
587 | \index{display\_info() (MarsRetrieval.MarsRetrieval method)@\spxentry{display\_info()}\spxextra{MarsRetrieval.MarsRetrieval method}} |
---|
588 | |
---|
589 | \begin{fulllineitems} |
---|
590 | \phantomsection\label{\detokenize{api:MarsRetrieval.MarsRetrieval.display_info}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{display\_info}}}{}{} |
---|
591 | Prints all class attributes and their values to the |
---|
592 | standard output. |
---|
593 | |
---|
594 | \end{fulllineitems} |
---|
595 | |
---|
596 | \index{print\_infodata\_csv() (MarsRetrieval.MarsRetrieval method)@\spxentry{print\_infodata\_csv()}\spxextra{MarsRetrieval.MarsRetrieval method}} |
---|
597 | |
---|
598 | \begin{fulllineitems} |
---|
599 | \phantomsection\label{\detokenize{api:MarsRetrieval.MarsRetrieval.print_infodata_csv}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{print\_infodata\_csv}}}{\emph{inputdir}, \emph{request\_number}}{} |
---|
600 | Write all request parameter in alpabetical order into a “csv” file. |
---|
601 | \begin{quote}\begin{description} |
---|
602 | \item[{Parameters}] \leavevmode\begin{itemize} |
---|
603 | \item {} |
---|
604 | \sphinxstyleliteralstrong{\sphinxupquote{inputdir}} (\sphinxstyleliteralemphasis{\sphinxupquote{str}}) \textendash{} The path where all data from the retrievals are stored. |
---|
605 | |
---|
606 | \item {} |
---|
607 | \sphinxstyleliteralstrong{\sphinxupquote{request\_number}} (\sphinxstyleliteralemphasis{\sphinxupquote{int}}) \textendash{} Number of mars requests for flux and non-flux data. |
---|
608 | |
---|
609 | \end{itemize} |
---|
610 | |
---|
611 | \end{description}\end{quote} |
---|
612 | |
---|
613 | \end{fulllineitems} |
---|
614 | |
---|
615 | |
---|
616 | \end{fulllineitems} |
---|
617 | |
---|
618 | |
---|
619 | |
---|
620 | \subsection{UioFiles} |
---|
621 | \label{\detokenize{api:uiofiles}} |
---|
622 | |
---|
623 | \section{Modules} |
---|
624 | \label{\detokenize{api:modules}} |
---|
625 | |
---|
626 | \subsection{get\_mars\_data} |
---|
627 | \label{\detokenize{api:get-mars-data}} |
---|
628 | |
---|
629 | \subsection{prepare\_flexpart} |
---|
630 | \label{\detokenize{api:prepare-flexpart}} |
---|
631 | |
---|
632 | \subsection{tools} |
---|
633 | \label{\detokenize{api:tools}} |
---|
634 | |
---|
635 | \subsection{disaggregation} |
---|
636 | \label{\detokenize{api:module-disaggregation}}\label{\detokenize{api:disaggregation}}\index{disaggregation (module)@\spxentry{disaggregation}\spxextra{module}} |
---|
637 | Disaggregation of deaccumulated flux data from an ECMWF model FG field. |
---|
638 | \begin{description} |
---|
639 | \item[{Initially the flux data to be concerned are:}] \leavevmode\begin{itemize} |
---|
640 | \item {} |
---|
641 | large-scale precipitation |
---|
642 | |
---|
643 | \item {} |
---|
644 | convective precipitation |
---|
645 | |
---|
646 | \item {} |
---|
647 | surface sensible heat flux |
---|
648 | |
---|
649 | \item {} |
---|
650 | surface solar radiation |
---|
651 | |
---|
652 | \item {} |
---|
653 | u stress |
---|
654 | |
---|
655 | \item {} |
---|
656 | v stress |
---|
657 | |
---|
658 | \end{itemize} |
---|
659 | |
---|
660 | \end{description} |
---|
661 | |
---|
662 | Different versions of disaggregation is provided for rainfall |
---|
663 | data (darain, modified linear) and the surface fluxes and |
---|
664 | stress data (dapoly, cubic polynomial). |
---|
665 | \index{IA3() (in module disaggregation)@\spxentry{IA3()}\spxextra{in module disaggregation}} |
---|
666 | |
---|
667 | \begin{fulllineitems} |
---|
668 | \phantomsection\label{\detokenize{api:disaggregation.IA3}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{disaggregation.}}\sphinxbfcode{\sphinxupquote{IA3}}}{\emph{g}}{} |
---|
669 | Interpolation with a non-negative geometric mean based algorithm. |
---|
670 | |
---|
671 | The original grid is reconstructed by adding two sampling points in each |
---|
672 | data series interval. This subgrid is used to keep all information during |
---|
673 | the interpolation within the associated interval. Additionally, an advanced |
---|
674 | monotonicity filter is applied to improve the monotonicity properties of |
---|
675 | the series. |
---|
676 | |
---|
677 | \begin{sphinxadmonition}{note}{Note:} |
---|
678 | (C) Copyright 2017-2019 |
---|
679 | Sabine Hittmeir, Anne Philipp, Petra Seibert |
---|
680 | |
---|
681 | This work is licensed under the Creative Commons Attribution 4.0 |
---|
682 | International License. To view a copy of this license, visit |
---|
683 | \sphinxurl{http://creativecommons.org/licenses/by/4.0/} or send a letter to |
---|
684 | Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. |
---|
685 | \end{sphinxadmonition} |
---|
686 | \begin{quote}\begin{description} |
---|
687 | \item[{Parameters}] \leavevmode |
---|
688 | \sphinxstyleliteralstrong{\sphinxupquote{g}} (\sphinxstyleliteralemphasis{\sphinxupquote{list of float}}) \textendash{} Complete data series that will be interpolated having |
---|
689 | the dimension of the original raw series. |
---|
690 | |
---|
691 | \item[{Returns}] \leavevmode |
---|
692 | \sphinxstylestrong{f} \textendash{} The interpolated data series with additional subgrid points. |
---|
693 | Its dimension is equal to the length of the input data series |
---|
694 | times three. |
---|
695 | |
---|
696 | \item[{Return type}] \leavevmode |
---|
697 | list of float |
---|
698 | |
---|
699 | \end{description}\end{quote} |
---|
700 | \subsubsection*{References} |
---|
701 | |
---|
702 | For more information see article: |
---|
703 | Hittmeir, S.; Philipp, A.; Seibert, P. (2017): A conservative |
---|
704 | interpolation scheme for extensive quantities with application to the |
---|
705 | Lagrangian particle dispersion model FLEXPART., |
---|
706 | Geoscientific Model Development |
---|
707 | |
---|
708 | \end{fulllineitems} |
---|
709 | |
---|
710 | \index{dapoly() (in module disaggregation)@\spxentry{dapoly()}\spxextra{in module disaggregation}} |
---|
711 | |
---|
712 | \begin{fulllineitems} |
---|
713 | \phantomsection\label{\detokenize{api:disaggregation.dapoly}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{disaggregation.}}\sphinxbfcode{\sphinxupquote{dapoly}}}{\emph{alist}}{} |
---|
714 | Cubic polynomial interpolation of deaccumulated fluxes. |
---|
715 | |
---|
716 | Interpolation of deaccumulated fluxes of an ECMWF model FG field |
---|
717 | using a cubic polynomial solution which conserves the integrals |
---|
718 | of the fluxes within each timespan. |
---|
719 | Disaggregation is done for 4 accumluated timespans which |
---|
720 | generates a new, disaggregated value which is output at the |
---|
721 | central point of the 4 accumulation timespans. |
---|
722 | This new point is used for linear interpolation of the complete |
---|
723 | timeseries afterwards. |
---|
724 | \begin{quote}\begin{description} |
---|
725 | \item[{Parameters}] \leavevmode |
---|
726 | \sphinxstyleliteralstrong{\sphinxupquote{alist}} (\sphinxstyleliteralemphasis{\sphinxupquote{list of array of float}}) \textendash{} List of 4 timespans as 2-dimensional, horizontal fields. |
---|
727 | E.g. {[}{[}array\_t1{]}, {[}array\_t2{]}, {[}array\_t3{]}, {[}array\_t4{]}{]} |
---|
728 | |
---|
729 | \item[{Returns}] \leavevmode |
---|
730 | \sphinxstylestrong{nfield} \textendash{} Interpolated flux at central point of accumulation timespan. |
---|
731 | |
---|
732 | \item[{Return type}] \leavevmode |
---|
733 | array of float |
---|
734 | |
---|
735 | \end{description}\end{quote} |
---|
736 | |
---|
737 | \begin{sphinxadmonition}{note}{Note:}\begin{description} |
---|
738 | \item[{March 2000}] \leavevmode{[}P. JAMES{]} |
---|
739 | Original author |
---|
740 | |
---|
741 | \item[{June 2003}] \leavevmode{[}A. BECK{]} |
---|
742 | Adaptations |
---|
743 | |
---|
744 | \item[{November 2015}] \leavevmode{[}Leopold Haimberger (University of Vienna){]} |
---|
745 | Migration from Fortran to Python |
---|
746 | |
---|
747 | \end{description} |
---|
748 | \end{sphinxadmonition} |
---|
749 | |
---|
750 | \end{fulllineitems} |
---|
751 | |
---|
752 | \index{darain() (in module disaggregation)@\spxentry{darain()}\spxextra{in module disaggregation}} |
---|
753 | |
---|
754 | \begin{fulllineitems} |
---|
755 | \phantomsection\label{\detokenize{api:disaggregation.darain}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{disaggregation.}}\sphinxbfcode{\sphinxupquote{darain}}}{\emph{alist}}{} |
---|
756 | Linear interpolation of deaccumulated fluxes. |
---|
757 | |
---|
758 | Interpolation of deaccumulated fluxes of an ECMWF model FG rainfall |
---|
759 | field using a modified linear solution which conserves the integrals |
---|
760 | of the fluxes within each timespan. |
---|
761 | Disaggregation is done for 4 accumluated timespans which generates |
---|
762 | a new, disaggregated value which is output at the central point |
---|
763 | of the 4 accumulation timespans. This new point is used for linear |
---|
764 | interpolation of the complete timeseries afterwards. |
---|
765 | \begin{quote}\begin{description} |
---|
766 | \item[{Parameters}] \leavevmode |
---|
767 | \sphinxstyleliteralstrong{\sphinxupquote{alist}} (\sphinxstyleliteralemphasis{\sphinxupquote{list of array of float}}) \textendash{} List of 4 timespans as 2-dimensional, horizontal fields. |
---|
768 | E.g. {[}{[}array\_t1{]}, {[}array\_t2{]}, {[}array\_t3{]}, {[}array\_t4{]}{]} |
---|
769 | |
---|
770 | \item[{Returns}] \leavevmode |
---|
771 | \sphinxstylestrong{nfield} \textendash{} Interpolated flux at central point of accumulation timespan. |
---|
772 | |
---|
773 | \item[{Return type}] \leavevmode |
---|
774 | array of float |
---|
775 | |
---|
776 | \end{description}\end{quote} |
---|
777 | |
---|
778 | \begin{sphinxadmonition}{note}{Note:}\begin{description} |
---|
779 | \item[{March 2000}] \leavevmode{[}P. JAMES{]} |
---|
780 | Original author |
---|
781 | |
---|
782 | \item[{June 2003}] \leavevmode{[}A. BECK{]} |
---|
783 | Adaptations |
---|
784 | |
---|
785 | \item[{November 2015}] \leavevmode{[}Leopold Haimberger (University of Vienna){]} |
---|
786 | Migration from Fortran to Python |
---|
787 | |
---|
788 | \end{description} |
---|
789 | \end{sphinxadmonition} |
---|
790 | |
---|
791 | \end{fulllineitems} |
---|
792 | |
---|
793 | |
---|
794 | |
---|
795 | \chapter{Support} |
---|
796 | \label{\detokenize{support:support}}\label{\detokenize{support::doc}}\begin{quote} |
---|
797 | |
---|
798 | UNDER CONSTRUCTION |
---|
799 | \end{quote} |
---|
800 | |
---|
801 | |
---|
802 | \section{Ticket System} |
---|
803 | \label{\detokenize{support/ticket_system:ticket-system}}\label{\detokenize{support/ticket_system::doc}}\begin{quote} |
---|
804 | |
---|
805 | UNDER CONSTRUCTION |
---|
806 | \end{quote} |
---|
807 | |
---|
808 | |
---|
809 | \section{Mailing Lists} |
---|
810 | \label{\detokenize{support/mailing_list:mailing-lists}}\label{\detokenize{support/mailing_list::doc}}\begin{quote} |
---|
811 | |
---|
812 | UNDER CONSTRUCTION |
---|
813 | \end{quote} |
---|
814 | |
---|
815 | |
---|
816 | \section{Known Bugs and Issues} |
---|
817 | \label{\detokenize{support/known_bugs_issues:known-bugs-and-issues}}\label{\detokenize{support/known_bugs_issues::doc}}\begin{quote} |
---|
818 | |
---|
819 | UNDER CONSTRUCTION |
---|
820 | \end{quote} |
---|
821 | |
---|
822 | |
---|
823 | \section{FAQ - Frequently asked questions} |
---|
824 | \label{\detokenize{support/faq:faq-frequently-asked-questions}}\label{\detokenize{support/faq::doc}}\begin{quote} |
---|
825 | |
---|
826 | UNDER CONSTRUCTION |
---|
827 | \end{quote} |
---|
828 | |
---|
829 | |
---|
830 | \chapter{Indices and tables} |
---|
831 | \label{\detokenize{index:indices-and-tables}}\begin{itemize} |
---|
832 | \item {} |
---|
833 | \DUrole{xref,std,std-ref}{genindex} |
---|
834 | |
---|
835 | \item {} |
---|
836 | \DUrole{xref,std,std-ref}{modindex} |
---|
837 | |
---|
838 | \item {} |
---|
839 | \DUrole{xref,std,std-ref}{search} |
---|
840 | |
---|
841 | \end{itemize} |
---|
842 | |
---|
843 | |
---|
844 | \renewcommand{\indexname}{Python Module Index} |
---|
845 | \begin{sphinxtheindex} |
---|
846 | \let\bigletter\sphinxstyleindexlettergroup |
---|
847 | \bigletter{d} |
---|
848 | \item\relax\sphinxstyleindexentry{disaggregation}\sphinxstyleindexpageref{api:\detokenize{module-disaggregation}} |
---|
849 | \indexspace |
---|
850 | \bigletter{m} |
---|
851 | \item\relax\sphinxstyleindexentry{MarsRetrieval}\sphinxstyleindexpageref{api:\detokenize{module-MarsRetrieval}} |
---|
852 | \end{sphinxtheindex} |
---|
853 | |
---|
854 | \renewcommand{\indexname}{Index} |
---|
855 | \printindex |
---|
856 | \end{document} |
---|