Skip to content

Latest commit

 

History

History
21 lines (15 loc) · 1.14 KB

configuration.rst

File metadata and controls

21 lines (15 loc) · 1.14 KB

Configuration

The configuration of is set in the idmtools.ini file. This file is normally located in the project directory but will search up through the directory hierarchy, and lastly the files ~/.idmtools.ini on Linux and %LOCALAPPDATA%\idmtools\idmtools.ini on Windows. You can also specify the path to the idmtools file by setting the environment variable IDMTOOLS_CONFIG_FILE. An idmtools.ini file is recommended when using . If you want to generate an idmtools.ini file, see documentation about the Configuration Wizard <idmtools-ini-wizard>. Configuration values can also be set using environment variables. The variables name can be specified using the format IDMTOOLS_SECTION_OPTION except for common options, which have the format IDMTOOLS_OPTION.

If no configuration file is found, an error is displayed. To supress this error, you can use IDMTOOLS_NO_CONFIG_WARNING=1

common-parameters logging cli/wizard

Below is an example configuration file:

idmtools.ini