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.

backward_compatibility

In this module, backward compatibility issues are solved by mocking

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)

container_definitions

debug

decorators

Various decorators, mainly for class methods

directory

doc

Functionality for enriching docstrings.

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.

init_tests

Routines and classes used in tests

lazy_string

misc

Various classes and routines used thorough the package

no_output

Context manager, that suppress output to the given descriptor.

options

The classes for storing one configuration value.

parsing_results

process_output_reader

Readers for processes outputs.

repeated_configuration_containers

section_adaptors

When the data are validated, there can be need for merge two data sources: the old section and the newly set data.

subprocess

test

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