.. _env_vars:

Environment variables
---------------------

.. envvar:: EDITOR

  Specifies the text editor to use for editing files.
  If not set, `GNU nano <https://nano-editor.org>`_ is used as fallback.

.. envvar:: SCI_AUTHOR

  Author name used for different purposes (e.g. measurement operator suggestion, author of protocols).
  If not set, the user will be prompted to provide an author name.

.. envvar:: XRDT_DATABASE

  Specifies the path to the measurement database file (CSV).
  If not set, a default file path is used (``~/.local/share/xrd-tools/measurements.csv``).

.. envvar:: XRDT_DEVICES

  Specifies the path to the device file (JSON).
  If not set, a default file path is used (``~/.local/share/xrd-tools/devices.json``).

.. envvar:: XRDT_LOG_DIR

  Specifies the directory where log files are stored.
  If not set, a default directory in the user's home directory is used (``~/.local/share/xrd-tools/logs``).

.. envvar:: XRDT_MEASUREMENTS_DIR

  Specifies the directory where measurements are stored.
  If not set, a default directory in the user's home directory is used (``~/XRD_measurements``).

.. envvar:: XRDT_PRESETS

  Specifies the path to the preset file (JSON).
  If not set, a default file path is used (``~/.local/share/xrd-tools/presets.json``).

.. envvar:: XRDT_TEMPLATE_DIR

  Specifies the directory where custom measurement document templates are stored.
  If not set, a default directory in the user's home directory is used (``~/.local/share/xrd-tools/templates``).