Variable Boxplots¶
make run-plot-var-boxplot
Summary¶
This scripts reads data from a folder and show the box plots of a given variable for different given water masses.
Configuration¶
The configuration file for this script is config/plot_var_boxplot.toml (based on config/default_plot_var_boxplot.toml). All the parameters and their functionality are listed below:
Input/Output¶
LOADING_DIR
Directory from which to load data.
default: "bgc_data"
Expected type: str
SHOW
Whether to show the figure or not.
default: true
Expected type: bool
SAVE
Whether to save the figure or not.
default: false
Expected type: bool
SAVING_DIR
Directory in which to save the figure.
default: "bgc_figs"
Expected type: str
Data Selection¶
PLOT_VARIABLE
Variable to plot the box-whisker figure of.
default: "NTRA"
Expected type: str
DATE_MIN
First date to map (included).
default: "20070101"
Expected type: str (must match the YYYYMMDD format)
DATE_MAX
Last date to map (included).
default: "20121231"
Expected type: str (must match the YYYYMMDD format)
LATITUDE_MIN
Minimum latitude boundary to consider for the loaded data (included).
default: 50
Expected type: int or float
LATITUDE_MAX
Maximum latitude boundary to consider for the loaded data (included).
default: 90
Expected type: int or float
LONGITUDE_MIN
Minimum longitude boundary to consider for the loaded data (included).
default: -180
Expected type: int or float
LONGITUDE_MAX
Maximum longitude boundary to consider for the loaded data (included).
default: 180
Expected type: int or float
WATER_MASS_ACRONYMS
List of the acronyms of the water masses to load. The acronyms are the ones defined in config/water_masses.toml, in the ACRONYM field.
default: ["AW", "PSWw"]
Expected type: list[str]
EXPOCODES_TO_LOAD
Precise expocode to load alone. If empty, no discrimination on expocode will be conducted.
default: []
Expected type: list[str]
PRIORITY
Providers priority list to use when removing duplicates.
default: ["GLODAP_2022", "CMEMS", "ARGO", "NMDC", "CLIVAR", "IMR", "ICES"]
Expected type: list[str]
Plotting Options¶
BOXPLOT_PERIOD
Period to use for each boxplot. Can be one of year, month, week or day.
default: "year"
Expected type: str
Others¶
VERBOSE
Verbose value, the higher, the more informations. If set to 0 or below: no information displayed. If set to 1: minimal informations displayed. If set to 2: very complete informations displayed. If set to 3 or higher: exhaustive informations displayed.
default: 2
Expected type: int
Script output¶
When executed, this script displays Box plots for a given variable, on multiple given water masses.
This is an example of what this plot could look like:
