Skip to content

Configuration

Learn how to configure idmtools for your environment.

Configuration file

idmtools.ini is an optional configuration file for defining platforms. When present, idmtools automatically searches for it starting from the current working directory and walking up through parent directories until it finds one or reaches the filesystem root.

You do not need this file — platforms can always be configured directly in code by passing parameters to Platform().

Platform configuration

COMPS

1
2
3
4
5
# idmtools.ini
[My_COMPS]  # This is block name. user can give any name
type = COMPS
endpoint = https://comps.idmod.org
environment = Calculon

1
2
3
4
5
# With idmtools.ini
platform = Platform("My_COMPS")   # block name

# Or without idmtools.ini
platform = Platform("Calculon")   # platform configuration alias

Slurm

1
2
3
4
# idmtools.ini
[My_Slurm]
type = SLURM_LOCAL
job_directory = MY_JOB_DIRECTORY

1
2
3
4
5
# With idmtools.ini
platform = Platform("My_Slurm")

# Or without idmtools.ini
platform = Platform("Slurm_Local", job_directory="MY_JOB_DIRECTORY")

Container

1
2
3
4
# idmtools.ini
[My_container]
type = Container
job_directory = MY_JOB_DIRECTORY

1
2
3
4
5
# With idmtools.ini
platform = Platform("My_container")

# Without idmtools.ini
platform = Platform("Container", job_directory="MY_JOB_DIRECTORY")

Note

To get platform aliases, run idmtools cli command:

idmtools info plugins platform-aliases

Next steps