configuration

Full name: ase2sprkkr.configuration

Module class hierarchy

Inheritance diagram of ase2sprkkr.configuration.ConfigFileDefinition, ase2sprkkr.configuration.ConfigValueDefinition, ase2sprkkr.configuration.Configuration, ase2sprkkr.configuration.ConfigurationOption, ase2sprkkr.configuration.ExecutionProfile, ase2sprkkr.configuration.G, ase2sprkkr.configuration.GeneratedConfigValueDefinition, ase2sprkkr.configuration.GeneratedConfigurationOption, ase2sprkkr.configuration.ProfilesSection, ase2sprkkr.configuration.Section, ase2sprkkr.configuration.V


Description

ASE2SPRKKR user configuration.

Module Attributes

EXECUTOR

The definition of ASE2SPRKKR configuration

Functions

_get_suffix(*_)

_legacy_executable_dir(section)

_legacy_executable_suffix(section)

_legacy_mpi(section)

_legacy_mpi_warning(section)

_legacy_value(section, name[, default])

_load_legacy_user_preferences(file)

_profile_overlay_values(yaml_file)

Return profile values from the Python hook not overridden by YAML.

_set_legacy_executable_dir(section, value)

_set_legacy_executable_suffix(section, value)

_set_legacy_mpi(section, value)

_set_legacy_mpi_warning(section, value)

_set_legacy_value(section, value, name)

legacy_user_preferences_file()

Return the optional Python user-configuration hook filename.

load_user_preferences()

Load the Python hook and then overlay config.yaml if present.

user_preferences_directory()

Return the ASE2SPRKKR user configuration directory.

user_preferences_file()

Return the preferred YAML user configuration filename.

Classes

ConfigFileDefinition(name[, members, ...])

ConfigValueDefinition(name[, type, ...])

Configuration(definition[, container])

ConfigurationOption(definition[, container, ...])

ExecutionProfile(definition[, container])

Mutable named execution profile stored in ASE2SPRKKR configuration.

G

alias of ase2sprkkr.configuration.GeneratedConfigValueDefinition

GeneratedConfigValueDefinition(name, getter)

GeneratedConfigurationOption(definition[, ...])

Configuration option whose value is backed by another config object.

ProfilesSection(name[, members, ...])

Definition of the dict-like named execution-profile section.

Section(name[, members, written_name, info, ...])

V

alias of ase2sprkkr.configuration.ConfigValueDefinition