Kamil Nešetřil

Environmental data management and analytics

User Tools

Site Tools


Configuration file

Specification

↩ Back

Each group of graphs is defined in a single configuration file in YAML format.
The value auto always represents the default value. Logical values can be written freely, e.g., yes, Yes, true, True.

title

Defines the main title of the entire output (the entire image).

Supports mathematical expressions in LaTeX syntax (enclosed in $$), which is the standard in Matplotlib.

If not specified, no title is shown.

Example: title: $^{79}Se$ in water

maximize

Displays a maximized window (if window: True is set)

Default: no

Example: maximize: yes

time_label

Label of the time axis

If not specified, no label is shown.

Example: time_label: "Time [years]"

time_range

Time axis range

Default: auto

Example: time_range: [100000, 1700000]

time_major_step

Main axis division – time step (major ticks)

Default: auto

Example: time_major_step: 1e5

time_format

Format of numbers on the time axis (x-axis). This setting controls how time values are displayed on the axis – for example, as plain numbers, scientific notation, or fixed decimal places.

Options:

  • Ggeneral format (e.g., 123456 or 0.00123 depending on number size)
  • Eexponential (scientific notation, e.g., 1.23E+05)
    • 4E – same but with 4 decimal places (e.g., 1.2345E+05)
  • Ffixed decimal places (e.g., 123456.0000)
    • 2F – same with 2 decimals (e.g., 123456.00)

Default: auto

Example: time_format: 3F

global_time_formula

Formula for transforming the time value. If this is set, the individual time_formula is not applied.

Example: global_time_formula: t / 1000

outputs

Defines output options:

  • whether the resulting graph is displayed in a window,
  • whether an image file is created (e.g., PNG).

window

Specifies whether an interactive Matplotlib window (GUI window) should be opened after the graph is rendered.

Options:

  • True – show window with graph (default)
  • False – graph is saved to a file only, no window (suitable for batch processing)

Example: window: False

image_file_name

Output image name (only one allowed).

Supported formats: eps, jpeg, jpg, pdf, png, ps, raw, svg, svgz, tif, webp

Example: image_file_name: simple.svg

axes

Defines individual subplots in a group of graphs sharing the same time axis.

values_label

Label for the vertical axis (y-axis), shown next to each subplot.

Supports formatting in Matplotlib:

  • LaTeX syntax enclosed in $…$
    • Example: values_label: "c [kg/m$^{3}$]"
  • Unicode characters (e.g., ³)
    • Example: values_label: "c [kg/m³]"

Default: empty string

values_range

Value range for the y-axis.

Default: auto equals [min, max].

Example: values_range: [0, 10]

values_major_step

Distance between major ticks on the y-axis.

Example: values_major_step: 0.0001

values_format

Format for numerical values on the y-axis. Syntax is the same as time_format.

Example: values_format: G

legend_on

Specifies whether to display a legend in the subplot (explaining each time series).

Default: Yes

Example: legend_on: No

grid_on

Specifies whether to show a grid in the subplot (guidelines along axes).

Options:

  • yes – show background grid (default)
  • no – no grid

Example: grid_on: no

title

Title of the individual subplot.

Example: title: Container

series

A list of time series to be shown in the given subplot.

input_file

Path to the input CSV file from which the time series is loaded.

Example: input_file: u_r_05.csv

separators

Defines the format of the input CSV file – specifically the decimal and column separators.

Options:

Value Decimal separator Column separator
dec._col, . ,
dec._col; . ;
dec._colTAB . tab
dec._colSPACE . space
dec,_col; , ;
dec,_colTAB , tab
dec,_colSPACE , space

Default: dec,_col;

Example: separators: dec,_col;

time_column

Name of the column in the CSV file that contains time values.

Example: time_column: time_1000yr

time_formula

Formula for transforming the time value. Works similarly to global_time_formula, but has lower priority.

Default: t

Example: time_formula: t / 100000

value_column

Name of the column in the CSV file that contains the values of the time series (y-axis). Each value is matched with the corresponding time from the time_column.

Example: value_column: se79_cont_water

value_formula

Formula for transforming the value.

Default: v (the original value)

Example: value_formula: v * 1000

corner

Position of the axis range

Options:

  • No: y-axis range matches exactly the data range.
  • Yes: y-axis range is enlarged by 5%.

Default: Yes

Example: corner: no

legend

Text shown in the legend for the given time series. If omitted, the column name from value_column is used.

Default: auto

Example: legend: Here is time series name

time_frame

Limits the time range shown for the given time series. Allows to crop part of a longer time series.

Defined as a pair of values: [start, end].

Default: [0, inf]

Example: time_frame: [200000, 1500000]

line_width

Thickness of the line used to draw the time series in the graph.

Default: 1

Example: line_width: 2.5

color

Color of the line representing the time series.

Can be specified using standard Matplotlib names: List of named colors | CSS – e.g., red, green, blue, yellow, orange, gray, brown, purple, pink

Default: auto

Example: color: black

line_style

Line style used to draw the time series.

Options (see Matplotlib Linestyles):

Value Style
"-" solid
":" dotted
"--" dashed
"-." dashdot

Default: -

Example: line_style: ":"



This is the specification. Example YAML configuration files can be found on separate pages:

Last modified: