epygram.args_catalog — Catalog of command-line arguments

Contains a catalog of reusable command-line arguments for argparse, with a function add_arg_to_parser to import them to an argparse parser.

The arguments are classified by categories, each category being a dict.

Each argument is a list composed as follows: [‘name’, ‘alternate_name1’, ‘alternate_name2’, ..., dict(kw1, kw2, kw3, ...)] where the keywords ‘kwi’ are argparse.ArgumentParser.add_argument() optional arguments.

Functions

epygram.args_catalog.add_arg_to_parser(parser, arg, **flychanges)[source]

Wrapper to add one item arg of the following dictionaries to a parser.

flychanges enable to change argument options on the fly.

Catalogs

epygram.args_catalog.files_management = {'replace_by_product': ['-m', '--multiply', {'default': False, 'dest': 'replace_op', 'const': 'multiply', 'help': 'replaces the fields by the product fields (filename * source).', 'action': 'store_const'}], 'source_file': ['-s', '--source', {'dest': 'refname', 'required': True, 'type': <type 'str'>, 'help': 'name of the 2nd file from which to extract the fields.'}], 'replace_by_reversediff': ['-r', '--reversediff', {'default': False, 'dest': 'replace_op', 'const': 'reversediff', 'help': 'replaces the fields by the reverse difference fields (source - filename).', 'action': 'store_const'}], 'replace_by_diff': ['-d', '--diff', {'default': False, 'dest': 'replace_op', 'const': 'diff', 'help': 'replaces the fields by the difference fields (filename - source).', 'action': 'store_const'}], 'in_place': ['-i', '--in_place', {'default': False, 'action': 'store_true', 'help': 'the operation on fields is done "in place" on the file, not on a new file.'}], 'several_files': ['filenames', {'nargs': '+', 'type': <type 'str'>, 'help': 'names of the files to be processed.'}], 'replace_by_addition': ['-a', '--add', {'default': False, 'dest': 'replace_op', 'const': 'add', 'help': 'replaces the fields by the addition fields (filename + source).', 'action': 'store_const'}], 'file_to_refer_in_diff': ['-d', '--diff', {'dest': 'refname', 'type': <type 'str'>, 'help': 'name of the 2nd (reference) file to be processed, to which comparison is done.'}], 'principal_file': ['filename', {'type': <type 'str'>, 'help': 'name of the file to be processed.'}], 'file_to_refer_in_diffonly': ['-D', '--diffonly', {'dest': 'Drefname', 'type': <type 'str'>, 'help': 'same as -d/--diff, but only fields difference is processed.'}]}

Arguments dealing with files

epygram.args_catalog.fields_management = {'netCDF_compression': ['--nc_comp', {'default': '4', 'type': <type 'int'>, 'help': 'compression level to compress fields in netCDF. Ranges from 0 to 9. 0 is no compression, 1 is low-but-fast compression, 9 is high-but-slow compression. Default to 4', 'choices': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]}], 'GRIB_sort': ['-k', '--sortbykey', {'default': False, 'dest': 'sortfields', 'help': "GRIB only: sort fields with regards to the given fid key. Only for *mode* == 'one+list' or 'fid_list'."}], '2fields_mode': ['-y', '--2fields_mode', {'default': None, 'help': "mode for 2-fields joining: - 'vectorize': sets a vector with each field as a component - 'superpose': superpose second field over the first with contourlines - '-': computes and plots the difference field - '+': computes and plots the sum field - '*': computes and plots the product field - '/': computes and plots the division field"}], 'DDHLFA_multiple_fields': ['-f', '-F', '--field', {'default': None, 'help': "name of the field to be processed. Regular expressions can be used, such as 'F*FLUVERTDYN' or 'VKK[0-1]'. In case this option is not used, no more than '-l' option, all fields present in file are processed. Fields not found in file are ignored. To obtain the list of fields in file, use the 'ddhlfa_what' tool."}], 'vertical_field': ['-F', '-f', '--field', {'default': None, 'required': True, 'help': "designation of the fields from which to extract profile. Syntax depends on format: GRIB: handgrip designing the parameter and the type of levels. FA: name of the upper-air field to be processed, with a * for level. To obtain the list of fields in file, use the 'epy_what' tool."}], 'sort_fields': ['-s', '--sortfields', {'default': False, 'action': 'store_true', 'help': 'not for GRIB: sort fields with regards to their name and type.'}], 'field': ['-f', '-F', '--field', {'default': None, 'help': "*fid* = *field identifier* of of the field(s) to be processed. Syntax depends on format: GRIB: handgrip, e.g. 'shortName:t,level:850'. FA: name, e.g. 'S050TEMPERATURE'; regular expressions may be used, such as 'S00[2-6]WIND.[U-V].PHYS', 'SURFALBEDO*' or 'SURF?.OF.OZONE'. To obtain the list of fields in file, use the 'epy_what' tool."}], 'windfieldU': ['--wU', '--Ucomponentofwind', {'default': None, 'dest': 'Ucomponentofwind', 'help': 'to process wind as a vector. U component of wind. (same syntax as -f). Not implemented in difference mode.'}], 'windfieldV': ['--wV', '--Vcomponentofwind', {'default': None, 'dest': 'Vcomponentofwind', 'help': 'to process wind as a vector. V component of wind. (same syntax as -f). Not implemented in difference mode.'}], 'FA_multiple_fields': ['-f', '-F', '--field', {'default': None, 'help': "name of the field to be processed. Regular expressions can be used, such as 'S00[2-6]WIND.[U-V].PHYS' to process meridian and zonal winds of levels 2 to 6, 'SURFALBEDO*' to process all kinds of albedo, 'SURF?.OF.OZONE' to process all kinds of ozone (A,B,C). In case this option is not used, no more than '-l' option, all fields present in file are processed. Fields not found in file are ignored. To obtain the list of fields in file, use the 'fa_what' tool."}], 'GRIB2_packing': ['--GRIB2_packing', {'default': None, 'help': 'packing for writing GRIB2s. Defaults to (undefined)..'}], 'windfield': ['-w', '--computewind', {'default': None, 'help': "to process wind as a vector. Syntax depends on format: FA: 'S*WIND' or 'P*VENT', 'H*VENT', 'V*VENT', 'CLSVENT.*', or 'CLS*.RAF'; * designing the level: combination of (*, ?, digits). GRIB: handgrip, e.g. 'shortName:u+v,level:850' or 'indicatorOfParameter:33+34,level:850' or 'parameterCategory:2,parameterNumber:2+3,level:850'. Not implemented in difference mode."}], 'FA_windfield': ['-w', '--computewind', {'default': None, 'help': "to process wind module, using the following syntax: 'S*WIND' or 'P*VENT', 'H*VENT', 'V*VENT', 'CLSVENT.*', 'CLS*.RAF', * designing the level: combination of (*, ?, digits). Not implemented in difference mode."}], 'GRIB_field': ['-F', '-f', '--field', {'default': None, 'help': "(possibly partial) handgrip of the field to be processed. To obtain the list of fields in file (and their handgrip), use EPyGrAM's 'grib_what' tool or GRIB_API's 'grib_dump'. Ex: -f 'shortName:t,level:850'."}], 'FA_field': ['-f', '-F', '--field', {'default': None, 'help': "name of the field to be processed. To obtain the list of fields in file, use the 'fa_what' tool."}], 'GRIB_secondfield': ['-2', '--secondfield', {'default': None, 'help': "(possibly partial) handgrip of the second field to be processed. To obtain the list of fields in file (and their handgrip), use EPyGrAM's 'grib_what' tool or GRIB_API's 'grib_dump'. Ex: -f 'shortName:t,level:850'."}], 'GRIB_what_mode': ['-m', '--mode', {'default': 'one+list', 'help': "information display mode (GRIB only): 'one+list' gives the validity/geometry of the first field in GRIB, plus the list of fid; 'fid_list' gives only the fid of each field in GRIB; 'what' gives the values of the keys from each GRIB message that are used to generate an **epygram** field from the message (slower); 'ls' gives the values of the 'ls' keys from each GRIB message; 'mars' gives the values of the 'mars' keys from each GRIB message.", 'choices': ('one+list', 'fid_list', 'what', 'ls', 'mars')}], 'list_of_fields': ['-l', '--listoffields', {'default': None, 'help': 'name of an external file containing the list of fields to be processed, with the same specifications as for -f argument.'}], 'DDHLFA_domain': ['-n', '--domain_number', {'required': True, 'help': "number of the domain to plot. Multiple domains must be given within quotes, separated by comma. To obtain the list of domains in file, use the 'ddhlfa_what' tool."}], 'FA_vertical_field': ['-F', '-f', '--field', {'default': None, 'required': True, 'help': "name of the upper-air field to be processed, with a * for level. To obtain the list of fields in file, use the 'fa_what' tool."}], 'reverse_fields_selection': ['-r', '--reverse', {'default': False, 'action': 'store_true', 'help': 'reverse fields selection: all but those requested.'}], 'FA_set_compression': ['-k', '--kompression', {'default': None, 'type': <type 'int'>, 'help': 'bits number for FA gridpoint compression : KNBITS/KNBPDG. Defaults to 16.'}]}

Arguments dealing with fields

epygram.args_catalog.output_options = {'noplot': ['-n', '--noplot', {'default': False, 'action': 'store_true', 'help': 'disable plot. Profile/spectrum will be computed and written as text output but not plotted.'}], 'stdout': ['-o', '--stdout', {'default': False, 'action': 'store_true', 'help': 'redirects output to standard output (rather than file).'}], 'GeoPoints_llv': ['--llv', {'default': False, 'action': 'store_true', 'help': 'simplify GeoPoints format to LAT, LON, VALUE only.'}], 'GeoPoints_precision': ['-e', '--precision', {'default': 6, 'help': "precision on GeoPoints' values (number of decimals in scientific format). Default = 6."}], 'output_format': ['-o', '--output_format', {'required': True, 'help': "format of conversion output, among: 'grb' (GRIB2), 'geo' (GeoPoints), 'nc' (netCDF4).", 'choices': ['grb', 'geo', 'nc']}], 'GRIB_short_fid': ['-s', '--grib_short_fid', {'default': False, 'action': 'store_true', 'help': 'condense GRIB fid.'}], 'GRIB_other_options': ['--GRIB_other_options', {'default': None, 'help': "a set of key:value pairs, separated by commas, to be given to the GRIB message when writing. Ex: 'typeOfGeneratingProcess:12,productionStatusOfProcessedData:2'."}], 'precision': ['-e', '--precision', {'default': 4, 'help': 'precision on values (number of decimals in scientific format). Default = 4.'}], 'outputfilename': ['-O', '--outputfilename', {'default': False, 'help': 'store output in the specified filename (without format for graphical output, to be completed by -o/--output).'}], 'GeoPoints_lonlat_precision': ['-E', '--lonlat_precision', {'default': 6, 'help': "precision on GeoPoints' longitudes/latitudes (number of decimals). Default = 4."}], 'one_pdf': ['-p', '--pdf', {'default': False, 'action': 'store_true', 'help': 'store output (eventually multiple plots) in one .pdf file.'}], 'reproject_wind': ['--rw', '--reproject_wind', {'default': False, 'dest': 'reproject_wind', 'help': 'reprojects a wind vector (u, v) onto true zonal/meridian axes (assuming it is projected onto grid axes in fields).', 'action': 'store_true'}], 'get_field_details': ['-d', '--details', {'default': None, 'help': "get some details about each field. E.g. 'spectral' to inquire the spectralness of fields, or 'compression' to inquire compression parameters, 'grid' or 'comment' for LFI."}], 'output': ['-o', '--output', {'default': False, 'help': "store graphical output in file in with specified format, among ('png', pdf). Pdf is kind of disadvised, for it is very slow and produces much too big files...", 'choices': ['png', 'pdf']}], 'get_field_compression': ['-c', '--compression', {'default': False, 'action': 'store_true', 'help': 'get compression options of each field.'}], 'lonlat_precision': ['-E', '--lonlat_precision', {'default': 4, 'help': 'precision on longitudes/latitudes (number of decimals). Default = 4.'}]}

Arguments dealing with output

epygram.args_catalog.misc_options = {'femars.diff_to_avg': ['--avg', '--diff_to_avg', {'dest': 'diff_to_avg', 'default': False, 'action': 'store_true', 'help': 'instead of computing member to member differences, compute member-to-average-of-members differences.'}], 'operation_on_field': ['-x', '--operation', {'default': None, 'help': "do the requested operation on field right after reading it. Syntax: '-,273.15' (e.g. for K => C) or 'exp' to take the exponential of the field. The operand must be among (+,-,*,/) or 'normalize' or any numpy function. For '-' operand, use short-name option -x without spacetab between option and argument."}], 'mask_threshold': ['--mt', '--mask_threshold', {'dest': 'mask_threshold', 'default': None, 'help': "set a threshold to mask values. E.g. 'min=0.0' will mask negative values. 'min=0.0,max=1e8' will mask values outside these boundaries."}], 'pressure_unit_hpa': ['-u', '--pressure_unit_hpa', {'default': False, 'action': 'store_true', 'help': 'converts pressure in Pa to hPa.'}], 'diffoperation_on_field': ['-X', '--diffoperation', {'default': None, 'help': "do the requested operation on difference field right after computing it. Syntax: '-,273.15' (e.g. for K => C) or 'exp' to take the exponential of the field. The operand must be among (+,-,*,/) or 'normalize' or any numpy function. For '-' operand, use short-name option -X without spacetab between option and argument."}], 'array_flattening_order': ['--order', {'default': 'C', 'help': "for LAM arrays, whether to flatten in C (row-major) or Fortran (column-major) order 2D arrays. Default = 'C'."}], 'composition_with_field': ['--compose_with', {'default': None, 'help': "compose a transformed field with another field. Syntax: 'otherfield, composition, [file=otherfile], [preset='norm'|'ceil']'. The *composition* must be among (+,-,*,/). If *file* is filled (optional), the *otherfield* is read in it. If *preset* is filled (optional), one or several operation can be done on the *otherfield* before operation. Ex: 'SFX.FRAC_WATER, *, file=mypgd.fa, preset=ceil' will set non-water points of the plotted field (e.g. SFX.TS_WATER) to 0."}], 'LAMzone': ['-z', '--zone', {'default': 'CI', 'help': "zone of the domain, in LAM case: 'C' for zone C, 'CI' for zone C+I, 'CIE' for zone C+I+E. Default is 'CI'.", 'choices': ['C', 'CI', 'CIE']}]}

Miscellaneous arguments

epygram.args_catalog.graphical_options = {'vector_symbol': ['--vs', '--vector_symbol', {'default': 'barbs', 'dest': 'vector_symbol', 'help': "symbol to be used for vectors, among ('barbs', 'arrows', 'stream')."}], 'colormap': ['-c', '--colormap', {'default': 'jet', 'help': "name of the **matplotlib** colormap to use. Default is 'jet' (Cf. http://matplotlib.org/examples/color/colormaps_reference.html for standard matplotlib colormaps, or epygram.config.epygram_colormaps.keys() in a python interpreter for epygram's own colormaps). Custom colormaps can be defined (http://colormap.org or manually) and added in userconfig, in usercolormaps = {'my_cmap':'path_to_my_cmap'}."}], 'french_departments': ['--depts', {'default': False, 'action': 'store_true', 'help': 'draw french departments on map (instead of countries boundaries).'}], 'lonlat_zoom': ['--zoom', {'default': None, 'help': "optional zoom on the specified region of the plot. Forces to 'cyl' projection. Syntax: 'lonmin=-5, lonmax=1.2, latmin=40.8, latmax=51'. Overwrites 'projection' option."}], 'diff_center_cmap_on_0': ['-T', '--diffcenter_cmap_on_0', {'default': True, 'action': 'store_false', 'help': 'NOT to center the colormap of diff plots on the value 0. May be useful for fluxes decumulation.'}], 'background': ['--background', {'default': False, 'action': 'store_true', 'help': 'sets a background color to continents and oceans.'}], 'bluemarble': ['--bluemarble', {'default': 0.0, 'type': <type 'float'>, 'help': 'displays NASA\'s "blue marble" as background, with a transparency set to the given value [0.0, 1.0].'}], 'graphicmode': ['-g', '--graphicmode', {'default': 'colorshades', 'help': "graphical mode for plots, among ('colorshades', 'contourlines', 'points'). Default is 'colorshades'. There is a known bug (yet unsolved) with Arpege & contourlines.", 'choices': ['colorshades', 'contourlines', 'points']}], 'vertical_zoom': ['--zoom', {'default': None, 'help': "optional zoom (vertical reduction) on the profile plot. Ex: 'ymax=150, ymin=850'. The unit must be that of the vertical coordinate requested (hPa, m, level number)."}], 'points_size': ['-p', '--pointsize', {'default': 20, 'type': <type 'int'>, 'help': "size of points for *graphicmode* == 'points'. Defaults to 20."}], 'superpose_spectra_plots': ['-s', '--superposeplots', {'default': False, 'action': 'store_true', 'help': 'for superposing spectra of all requested fields in one plot.'}], 'figures_dpi': ['--fd', '--figures_dpi', {'default': 150, 'dest': 'figures_dpi', 'type': <type 'int'>, 'help': 'quality of saved figures.'}], 'spectra_zoom': ['--zoom', {'default': None, 'help': "optional zoom on the spectra plot. Ex: 'xmax=10, ymin=1.0'."}], 'quiverkey': ['--qk', '--quiverkey', {'default': None, 'dest': 'quiverkey', 'help': "arguments to be passed to pyplot.quiverkey(), in case *vector_symbol* == 'arrows'. E.g. X=1.05,Y=1.05,U=10.,label='10m/s'."}], 'vectors_subsampling': ['-s', '--vectors_subsampling', {'default': 20, 'type': <type 'int'>, 'help': 'Subsampling factor for plotting vectors barbs (-w: computewind option). Defaults to 20.'}], 'minmax': ['-m', '--minmax', {'default': None, 'help': "min and max values for the plot colorbar. Syntax: 'min, max'. '0.0, max' also works. Default is the field min/max values. In diff mode, this is valuable for resource and reference only, (min, max) for difference plot should be defined with --diffminmax option. For negative values, use short-name option -m without spacetab between option and argument."}], 'spectra_slopes': ['-k', '--kindofslopes', {'default': '-3 1.0 -3, -5./3. 1e-2 -5/3', 'help': "optional kind of slopes to be plotted, with syntax: sequence of (exp offset label) between simple quotes ('), with slope = offset * k**exp. offset is optional, with default = 1.0. Label is optional and denotes how do the exp appears in legend (by default, exp=0.5 will appear 1/2 => add a label 0.5 for it to appear unchanged.). If label is provided, offset must be provided as well. Ex: 'exp1, exp2 offset2 label2, exp3 offset3'. or '-3 1.0, -5./3. 1e-2 -5/3' (default)."}], 'legend': ['-L', '--legend', {'default': None, 'help': 'legend to be written over field plot.'}], 'parallels': ['--parallels', {'default': 'auto', 'type': <type 'str'>, 'help': "*meridians* and *parallels* enable to fine-tune the choice of lines to plot, with either: - 'auto': automatic scaling to the basemap extents (default) - 'default': range(0,360,10) and range(-90,90,10) - a list of values - a grid step, e.g. 5 to plot each 5 degree - None: no one is plot - 'equator' // 'polarcircles' // 'tropics' or any combination will plot only these."}], 'diff_levels_number': ['-N', '--difflevelsnumber', {'default': 50, 'type': <type 'int'>, 'help': 'number of levels for difference contours and shades. Default is 50.'}], 'gis_quality': ['-q', '--gisquality', {'default': 'i', 'help': "quality of the GIS used to draw coastlines, rivers and countries; among ('c', 'l', 'i', 'h', 'f'), by increasing quality.", 'choices': ['c', 'l', 'i', 'h', 'f']}], 'meridians': ['--meridians', {'default': 'auto', 'type': <type 'str'>, 'help': "Same as parallels, cf. parallels doc. Preset values are 'greenwich' and 'datechange'."}], 'levels_number': ['-n', '--levelsnumber', {'default': 50, 'type': <type 'int'>, 'help': 'number of levels for contours and shades. Default is 50.'}], 'section_abscissa': ['--section_abscissa', '--sa', {'default': 'distance', 'help': "abscissa of section, among ('distance', 'lon', 'lat')."}], 'scientifical_unit': ['-u', '--unit', {'default': 'SI', 'help': "optional unit for labeling plot axis. Defaults to 'SI'."}], 'diffminmax': ['-M', '--diffminmax', {'default': None, 'help': "min and max values for the difference plot colorbar. Syntax: 'min, max'. '0.0, max' also works. Default is the difference field min/max values. For negative values, use short-name option -M without spacetab between option and argument."}], 'emagram_like_profiles': ['-e', '--emagramlike', {'default': False, 'action': 'store_true', 'help': 'plots profiles in a emagram-like style (only with -P/--hybridP2pressure). Should not be used for other than Temperature profiles.'}], 'specific_map_projection': ['-j', '--projection', {'default': None, 'help': "specific graphical projection of plots, among ('kav7', 'ortho', 'cyl', 'moll', 'nsper[,sat_height=3000,lon=15.0,lat=55]'). Default depend on the actual projection of fields, or 'moll' (Mollweide projection) for Gauss geometry. For 'nsper', the additional parameters are optional: *sat_height* defines the satellite height in km, with a defaults value of 3000; *lon* and *lat* define the satellite nadir position, with default values to the field centre. Overwritten by 'zoom' option."}], 'draw_rivers': ['-r', '--drawrivers', {'default': False, 'action': 'store_true', 'help': 'draw rivers on map. (Much more slow)'}], 'vertical_logscale': ['-s', '--logscale', {'default': False, 'action': 'store_true', 'help': 'plots with vertical logscale.'}], 'center_cmap_on_0': ['-t', '--center_cmap_on_0', {'default': False, 'action': 'store_true', 'help': 'to center the colormap on the value 0. Can be useful for wind plots for instance.'}], 'global_shift_center': ['--global_shift_center', '--gsc', {'default': None, 'type': <type 'float'>, 'help': 'for global lon/lat grids, shift the center by the requested angle (in degrees). Enables a [0,360] grid to be shifted to a [-180,180] grid, for instance (with -180 argument).'}], 'diffcolormap': ['-C', '--diffcolormap', {'default': 'seismic', 'help': "name of the **matplotlib** colormap to use for diff. Default is 'seismic' (Cf. http://matplotlib.org/examples/color/colormaps_reference.html for standard matplotlib colormaps, or epygram.config.epygram_colormaps.keys() in a python interpreter for epygram's own colormaps). Custom colormaps can be defined (http://colormap.org or manually) and added in userconfig, in usercolormaps = {'my_cmap':'path_to_my_cmap'}."}]}

Arguments dealing with graphical options

epygram.args_catalog.extraction_options = {'section_transect_points_number': ['-p', '--points_number', {'default': None, 'type': <type 'int'>, 'help': 'number of points from starting point to ending point (included). Defaults to the number of points computed from the fields resolution, or from the resolution given via option -r.'}], 'verticalcoord2height': ['-H', '--verticalcoord2height', {'default': None, 'dest': 'Yconvert', 'const': 'height', 'help': 'compute height as vertical coordinate, if possible.', 'action': 'store_const'}], 'no_cheap_height_conversion': ['--no_cheap_height', {'default': True, 'dest': 'cheap_height', 'help': 'for the computation of heights (-A/-H) to be done taking hydrometeors into account (in R computation) and NH Pressure departure (Non-Hydrostatic data). Slower but more accurate.', 'action': 'store_false'}], 'section_transect_resolution': ['-r', '--resolution', {'default': None, 'type': <type 'float'>, 'help': 'resolution of the section. Defaults to the fields resolution, or computed from the number of points given via option -p.'}], 'section_ending_point': ['-e', '--ending_point', {'default': None, 'required': True, 'help': "lon/lat coordinate of ending point of the section. Syntax: 'lon, lat'."}], 'horizontal_interpolation': ['-i', '--interpolation', {'default': 'nearest', 'help': "interpolation mode from field grid to point/section coordinates. Among ('nearest', 'linear', 'cubic'). Defaults to 'nearest'.", 'choices': ['nearest', 'linear', 'cubic']}], 'external_distance': ['-z', '--external_distance', {'default': None, 'help': "for 'nearest' interpolation mode, the nearest is chosen among the 4 nearest points regarding the point whose value of field *EXT* is the closest to *VALUE*, with syntax: *external_distance* = 'VALUE; EXT'. EXT being a fid."}], 'verticalcoord2altitude': ['-A', '--verticalcoord2altitude', {'default': None, 'dest': 'Yconvert', 'const': 'altitude', 'help': 'compute altitude as vertical coordinate, if possible.', 'action': 'store_const'}], 'point_coordinates': ['-c', '--coordinates', {'default': None, 'required': True, 'help': "lon/lat coordinates of the point. Syntax: 'lon, lat'."}], 'section_starting_point': ['-s', '--starting_point', {'default': None, 'required': True, 'help': "lon/lat coordinate of starting point of the section. Syntax: 'lon, lat'."}], 'verticalcoord2pressure': ['-P', '--verticalcoord2pressure', {'default': None, 'dest': 'Yconvert', 'const': 'pressure', 'help': 'compute pressure as vertical coordinate, if possible.', 'action': 'store_const'}]}

Arguments dealing with extraction stuff

epygram.args_catalog.runtime_options = {'percentage': ['-p', '--percentage', {'default': False, 'action': 'store_true', 'help': 'display the percentage done on the run.'}], 'threads_number': ['-t', '--threads_number', {'default': 2, 'type': <type 'int'>, 'help': 'number of threads to be run in parallel.'}], 'verbose': ['-v', '--verbose', {'default': False, 'action': 'store_true', 'help': 'run verbosely. Else, only messages of level Error will be displayed.'}]}

Arguments dealing with runtime options

epygram.args_catalog.operational_options = {'suite': ['-S', '--suite', {'default': 'research', 'help': "name of the suite, among (oper, dble, research, test). Defaults to research. Used to build GRIB's *productionStatusOfProcessedData*."}], 'numod': ['-N', '--NUMOD', {'default': None, 'dest': 'numod', 'type': <type 'int'>, 'help': "model identifier (known as NUMOD at Meteo-France). A.k.a. 'generatingProcessIdentifier' in GRIB_API. Default is 255."}], 'typeOfGeneratingProcess': ['-g', '--typeOfGeneratingProcess', {'default': 'Forecast', 'help': "GRIB's type of generating process.", 'choices': ['Post-processed analysis', 'Probability forecast', 'Observation', 'Hindcast', 'Ensemble forecast', 'Initialization', 'Forecast error', 'Probability-weighted forecast', 'Analysis', 'Forecast', 'Bias corrected forecast', 'Post-processed forecast', 'unknown', 'Climatological', 'Nowcast', 'Analysis error', 'Bias-corrected ensemble forecast']}]}

Operational arguments

epygram.args_catalog.domain_maker_options = {'no_display': ['-n', '--no_display', {'default': False, 'action': 'store_true', 'help': 'run without displaying the domain.'}], 'mode': ['-l', {'default': 'center_dims', 'action': 'store_const', 'const': 'lonlat_included', 'help': 'mode: define domain by specifying a lon/lat domain that must be included inside.', 'dest': 'mode'}], 'maximize_CI_in_E': ['-m', '--maximize_CI_in_E', {'default': False, 'action': 'store_true', 'help': 'forces the C+I zone to be the greatest possible inside a given (discrete) C+I+E size. In other words, with a given (discrete) C+I+E size, forces the E-zone to be the smallest possible.'}]}

Arguments for domain_maker

Table Of Contents

Previous topic

epygram.spectra — Class and functions for spectra

Next topic

External, side modules

This Page