.. index:: single: ebas_plot; program .. program:: ebas_plot .. _EBASprogram_ebas_plot: ebas_plot ========= The program *ebas_plot* plots data, as graphs or as maps, from the EBAS database or from Nasa/ames files. .. versionadded:: 3.00.08 Synopsis -------- :: ebas_plot [-h] [--version] [--cfgfile CFGFILE] [--loglevconsole LOGLEVCONSOLE] [--loglevfile LOGLEVFILE] [--logfile LOGFILE] [--profile] [--nodb] [--dbHost DBHOST] [--db DB] [--dbUser DBUSER] [--dbPasswd DBPASSWD] [--do_id DO_ID] [--setkey SETKEY] [--station STATION] [--project PROJECT] [--instrument INSTRUMENT] [--component COMPONENT] [--matrix MATRIX] [--group GROUP] [--fi_ref FI_REF] [--me_ref ME_REF] [--resolution RESOLUTION] [--statistics STATISTICS] [--datalevel DATALEVEL] [--time TIME] [--state STATE] [--diff DIFF] [--us_id US_ID] [--format FORMAT] [--graphstyle GRAPHSTYLE] [--setminmax SETMINMAX] [--flags FLAGS] [--gridsize GRIDSIZE] [--figsize FIGSIZE] [--nolegend] [--legendsize LEGENDSIZE] [--settitle SETTITLE] [--titlesize TITLESIZE] [--colormap COLORMAP] [--projection PROJECTION] [--showlatlon] [--setlatlon SETLATLON] [--setscale SETSCALE] [--intscale INTSCALE] [--modscale] [--background BACKGROUND] [--dotsize DOTSIZE] [--ignore IGNORE] [--stat STAT] [--year | --month | --week | --day | --hour] [--lower_limit LOWER_LIMIT] [--upper_limit UPPER_LIMIT] [--perc PERC | --aot AOT] [--zenith] [--amount] [--nasaames [NASAAMES [NASAAMES ...]]] [--file [FILE [FILE ...]]] [--file_db [FILE_DB [FILE_DB ...]]] [--createfiles CREATEFILES] [--destdir DESTDIR] Commandline arguments --------------------- General arguments `````````````````` .. include:: ./include/commandline_arguments/general.include Configuration arguments ```````````````````````` .. include:: include/commandline_arguments/config.include Logging arguments ````````````````` .. include:: include/commandline_arguments/logging.include Database arguments ``````````````````` .. include:: include/commandline_arguments/db.include Commandline arguments for dataset selection criteria ```````````````````````````````````````````````````` Dataset selection criteria are used to define a set of datasets to be plotted by *ebas_plot*. .. include:: include/commandline_arguments/ds_criteria.include Time interval criteria `````````````````````` .. include:: include/commandline_arguments/time.include Database state arguments ```````````````````````` .. include:: include/commandline_arguments/state.include Arguments specific to *ebas_plot* ````````````````````````````````` By default the figures will be shown on screen, to the user, in an interface. Here is a link to a guide explaning how to use the interface: https://matplotlib.org/users/navigation_toolbar.html Plot arguments ^^^^^^^^^^^^^^ .. option:: --format=FORMAT Available options: map, multi, stationmap If no format is specified each graph will be plotted, as time series, in separate plots. If a format is specified with --format the following effects will be applied: * map: The datapoints will be plotted on a map. One map will be created for each sample in time. It is recommended to use statistical arguments in combination with map in order to recieve a manageable number of maps. * stationmap: A map showing the placement of the stations will be created. * multi: All regular time series will be plotted in together in a single plot. Optional, Default: None .. versionadded:: 3.02.01 stationmap .. versionchanged:: 3.02.01 drop option ``--stationmap``, use ``--format stationmap`` .. option:: --graphstyle=GRAPHSTYLE Allowed values: scatter, forcelines Choose a special graphstyle for the plot. * scatter: Creates a scatter plot. (Markers instead of lines) * forcelines: Create lines even if the measurements are discontinous. Optional, Default: None .. option:: --setminmax=SETMINMAX Set the minimum and maximum values for the y-axis or the colorbar. The values should be given as a list of two floats. Format: MIN,MAX Optional, Default: None .. versionadded:: 3.02.01 .. versionchanged:: 3.02.01 option ``--colorbar`` dropped, use ``--setminmax`` .. option:: --flags=FLAGS Inculde information on data flags. Allowed values: (Multiple can be given in a list) * I: Show invalid values as red dots. * V: Show valid values as green dots. * A: Plot all values ignoring validity. .. note:: I and V are only avalible for time series only. Optional, Default: None .. option:: --gridsize=GRIDSIZE The number of plots to place in the figure. Format: X,Y X: The number of plots, horizontally, in a figure. Y: The number of plots, vertically, in a figure. Optional, Default: (1, 1) .. option:: --figsize=FIGSIZE Size of the figure in inches. Format: X,Y Optional, Default: None .. option:: --nolegend Remove legends from all plots. Optional, Default: False .. option:: --legendsize=FONTSIZE_LEGEND Set the fontsize/dotsize for legends. The value should be given in points. Optional, Default: None .. versionadded:: 3.02.01 .. option:: --settitle=SETTITLE Set custom titles for the plots. For one plot specify a string. For multiple plots specify a list of strings separated by a comma. To remove the titles from all plots use ``--settitle notitle`` Optional, Default: None .. versionchanged:: 3.02.01 The option ``--settitles`` has beed renamed ito ``--settitle`` .. versionchanged:: 3.02.01 The option ``--notitle`` has beed dropped, use ``--settitle notitle`` .. option:: --titlesize=TITLESIZE Set the size of the titles. The value should be given in points. Optional, Default: None .. versionadded:: 3.02.01 .. option:: --colormap=COLORMAP Set a colormap for dmps/map/stationmap plots. Allowed values: :: 'jet', 'jet_r', 'gnuplot2', 'gnuplot2_r', 'Purples', 'Purples_r', 'hot', 'hot_r', 'cool', 'cool_r', 'spring', 'spring_r', 'gist_rainbow', 'gist_rainbow_r', 'winter', 'winter_r' Optional, Default: jet .. versionadded:: 3.02.01 'jet_r', 'gnuplot2', 'Purples_r', 'hot', 'hot_r', 'cool', 'cool_r', 'spring', 'spring_r', 'gist_rainbow', 'gist_rainbow_r', 'winter', 'winter_r' Map arguments ^^^^^^^^^^^^^ .. option:: --projection=PROJECTION Allowed values: merc, cyl, stere, europe, scand, norway, CAMP Choose a projection type for map plots. * merc: Mercator projection. * cyl: Cylindrical projection. * stere: Stereographic projection. * europe: Europe in stereographic projection. * scand: Scandinavia in stereographic projection. * norway: Norway in stereographic projection. * CAMP: CAMP in stereographic projection. Optional, Default: merc/cyl .. versionadded:: 3.02.01 ``stere`` .. option:: --showlatlon Show the latitude and longitude for the lower left and upper right corner of the map. The latitude and longitudes will be shown at the bottom of the map. Optional, Default: False .. option:: --setlatlon=SETLATLON **Format Mercator And Cylindrical projection**: A list of positive floats specifying the latitude and longitude for the lower left and upper right corner of the map. This is used to choose a custom map section. Format: lower_left_latitude, lower_left_longitude, upper_right_latitude, upper_right_longitude .. note:: Positive latitude values must be followed by N, and negative values by S. Positive longitude values must be followed by E, and negative values by W. **Example**: Europe: :: --setlatlon 27N,30W,72N,43E **Format Stereographic projection**: All numbers must be positive floats. Format: lat_ts, lat_0, lon_0, width, height * lat_ts: latitude of true scale. * lat_0: centre point latitude. * lon_0: centre point longitude. * width: Width of the map in meters. * height: Height of the map in meters. .. note:: Positive latitude values must be followed by N, and negative values by S. Positive longitude values must be followed by E, and negative values by W. **Example**: Europe: :: Europe: --setlatlon 60N,58N,5E,5850000,5850000 Helcom: --setlatlon 62N,62N,15E,2000000,2000000 Optional, Default: None .. versionadded:: 3.02.01 Format Stereographic projection .. option:: --setscale=SETSCALE A list of floats specifying at what values the map markers will change color. Optional, Default: None .. option:: --intscale=INTSCALE A list of integers specifying at what values the map markers will change color. Optional, Default: None .. versionadded:: 3.02.01 .. option:: --modscale Interactive mode for modifying scale. If active, the plot will be showed on screen, and you will be prompted for a new scale. Optional, Default: False .. option:: --background=BACKGROUND Set the map colors and borders. Format: A list of one or two elements consisting of one color ('white', 'light', 'medium', 'dark' or 'relief') and/or 'countryborders'. * white: The map is white. * light: The map has light colors (blue and grey). * medium: The map has medium colors (blue and grey). * dark: The map has dark colors (blue and grey). * relief: A relief map is used. * countryborders: The country borders are drawn. Optional, Default: medium .. versionadded:: 3.02.01 .. option:: --dotsize=DOTSIZE Set the size of the markers on the map. Optional, Default: 150 .. option:: --ignore=IGNORE Allowed values: 'zero' * zero: Ignore zero values. Ignored values will not be plotted. Optional, Default: None .. versionadded:: 3.02.01 Statistical arguments ^^^^^^^^^^^^^^^^^^^^^ .. option:: --stat=STAT Allowed values: mean, capture, dep, sum, max, min, stdev, geom_mean, geom_stdev, perc, diurnal, aot, num_samples, num_bdl, num_days Apply a statistical method to the data before plotting. .. note:: The statistical method perc requires - -perc to be specified. The statistical method aot requres - -aot to be specified. Optional, Default: None .. option:: --year, --month, --week, --day, --hour Preforms the statistical method on data from one year/month/week/day/hour at a time. Optional, Default: False .. option:: --lower_limit=LOWER_LIMIT, --above=LOWER_LIMIT Only include values above the limit. Optional, Default: None .. option:: --upper_limit=UPPER_LIMIT, --below=UPPER_LIMIT Only include values below the limit. Optional, Default: None .. option:: --perc=PERC A percentile value or a list of percentile values. Optional, Default: None .. option:: --aot=AOT An aot value. Optionl, Default: None .. option:: --zenith Use zenith angle of 89 as cutoff for aot calulations. Optional, Default: False .. option:: --amount Include a plot of the precipitation amount. Optional, Default: False Input arguments ^^^^^^^^^^^^^^^ .. option:: --nasaames=[NASAAMES [NASAAMES ...]] Plot data from Nasa/Ames files. A filename or a list of filenames must be specified. In the list of filenames the names should be separated with space. Optional, Default: None .. versionchanged:: 3.02.01 rename option ``--filenames`` to ``--nasaames`` .. option:: --file=[FILE [FILE ...]] Plot data from files. A filename or a list of filenames must be specified. Two file formats are supported, statistics files and station class files. Station class files are used to create stationmapmaps with station classes. File format statistics files: :: station_code component_name matrix latitude longitude start_time - end_time value File format for station class files: :: # number_of_classes 1 class_1 \.\.\. n class_n station_code latitude longitude class_number Optional, Default: None .. versionadded:: 3.02.01 .. option:: --file_db=[FILE_DB [FILE_DB ...]] Plot data from files together with data from the database. A filename or a list of filenames must be specified. One file format is supported. File format: :: station_code component_name matrix latitude longitude start_time - end_time value Optional, Default: None .. versionadded:: 3.02.01 Output arguments ^^^^^^^^^^^^^^^^ .. option:: --createfiles=CREATEFILES Allowed values: png, eps, svg, pdf, jpg Set a file format for saving files. If you specify a file format with --createfiles the plots will be saved as files of the specified format. If you do not use the --createfiles option the plots will not be saved, but will be diplayed on the computer screen. Optional, Default: None .. option:: --destdir=DESTDIR Set the destination directory for the files created with --createfiles. Optional, Default: Current folder