common

Full name: ase2sprkkr.common

Description

sprkkr.common - common modules used in ase2sprkkr package

Modules

alternative_types

This module contains helper functions and data to deal with the problem, that numpy arrays contains their own datatypes and thus e.g. an int may not be what it seems.

async_utils

Compatibility import; implementation is owned by KKRunner.

backward_compatibility

Backward-compatibility helpers for supported Python versions.

configuration

This module contains just a base class for both configuration values - Options and configuration containers - Sections.

configuration_containers

In this file the common containers of configuration values are, either for task or potential.

configuration_definitions

Configuration definitions are classes, that desribes the syntax of a configuration file, or its parts (sections or configuration options)

configuration_transaction

Transactional staging and committing of configuration changes.

container_definitions

dangerous_values

Values that explicitly bypass configuration validation.

debug

decorators

Various decorators, mainly for class methods

dependencies

Values derived from other configuration definitions.

doc

Functionality for enriching docstrings.

file_fingerprints

Compatibility import; implementation is owned by KKRunner.

file_locks

Compatibility import; implementation is owned by KKRunner.

file_utils

file_versions

Compatibility import; implementation is owned by KKRunner.

formats

Formating routines

generated_configuration_definitions

Definition of value in configuration/output files, that is generated from other values

grammar

Various pyparsing grammar elements and a few useful routines.

grammar_types

Classes, that represents various value types that can appear in the configuration and problem definitionfiles.

lazy_string

misc

Various classes and routines used thorough the package

module_registry

Reusable discovery registry for values stored in Python modules.

no_output

Context manager, that suppress output to the given descriptor.

options

The classes for storing one configuration value.

output_printing

Output printing listeners independent of task-specific parsers.

parsing_results

process_output_reader

Parsers and stream helpers for calculation output.

repeated_configuration_containers

repetition

Definitions of the supported configuration-item repetition modes.

subprocess

temporary

Helpers for scoped temporary configuration values.

tools

This module contain support for the tools

unique_values

UniqueValuesMapping: the class for solving equivalence classes on a collection of objects.

value_definitions

warnings

This module implement simple class that encapsulates the warning about non-critical errors (or just suspicious data) in configuration/data files.

yaml

YAML - related stuff