Configuration#

There are a number of FastrPI variables that can be configured. When FastrPI starts up it loads the configuration file config.yaml from the FastrPI home folder.

The location of the FastrPI home folder can be set using environment variables. This folder will be set to:

  • $FASTRPIHOME, if set

  • $FASTRHOME / fastrpi, if set

  • ~/.fastr/fastrpi, if present

  • ~/.fastrpi

Configuration file#

From the configuration file the following variables can be set:

Attribute

Default value

Description

repository_urls{}

URLs for the Git repositories for the Tool and Network packages and the Docker repository for the Tools.

networks_git

git@gitlab.com:radiology/infrastructure/resources/fastrpi/fastrpi-networks.git |

tools_git

git@gitlab.com:radiology/infrastructure/resources/fastrpi/fastrpi-tools.git |

tools_docker

registry.gitlab.com/radiology/infrastructure/resources/fastrpi/fastrpi-tools |

container_type[]

['docker']

Container backends that should be used in the FastrPI client. This variable can be a list containing ['singularity', 'docker', 'singularity_slurm'].

tool_record_path

fastrpi_home / 'installed_tools.json'

Path of the install record files for the Tool Install Record.

network_record_path

fastrpi_home / 'installed_networks.json'

Path of the install record files for the Network Install Record.

datatypes_folder

fastrpi_home / 'datatypes'

Folder to store the Fastr Datatype definitions.

singularity_dir

fastrpi_home / 'singularity'

Folder to store pulled images through the Singularity backend.

gitlab_token_file

None

Text file containing the Gitlab token. Necessary for publishing packages.

slurm_pull_partition

None

Slurm partition that will be used for pulling using singularity_slurm container type.