Skip to content

Configuration Reference

The top-level Viper configuration file schema.

See the configuration overview for more details.


key type required description default
VIPER_CONFIG_PATH FilePath True Path to the viper config file
conda Optional[Conda] False Conda environment configuration
default_project_root Optional[DirectoryPath] False Default directory to place new projects
docs Mapping[str, str] False URLs to documentation sites {'viper': '', 'viper-forge': ''}
simulation_dirpath Path False Path to the directory for storing all simulation results /tmp/simulation


key type required description default
prefixes Mapping[str, Path] True
channels Optional[Mapping[str, Union[pathlib.Path, pydantic.networks.AnyHttpUrl, str]]] False