Configuration

class hcipy.config.Configuration

Bases: _ConfigurationItem

A configuration object that describes the current configuration status of the package.

Methods Summary

reset([enable_user_overrides])

Reset the configuration to the default configuration.

Methods Documentation

reset(enable_user_overrides=True)

Reset the configuration to the default configuration.

This default configuration consists of the default parameters in hcipy/data/default_config.yaml, which can be overridden by a configuration file in ~/.hcipy/hcipy_config.yaml. This can in turn be overridden by a configuration file named hcipy_config.yaml located in the current working directory.

Parameters:

enable_user_overridesbool

Whether to enable overrides of the config by the user-specific configuration files. The default is True.