common

Full name: ase2sprkkr.common

Description

sprkkr.common - common modules used in ase2sprkkr package

Modules

ase2sprkkr.common.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.

ase2sprkkr.common.doc

Functionality for enriching docstrings.

ase2sprkkr.common.no_output

Context manager, that suppress output to the given descriptor.

ase2sprkkr.common.configuration

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

ase2sprkkr.common.configuration_containers

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

ase2sprkkr.common.configuration_definitions

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

ase2sprkkr.common.container_definitions

ase2sprkkr.common.decorators

Various decorators, mainly for class methods

ase2sprkkr.common.directory

ase2sprkkr.common.formats

Formating routines

ase2sprkkr.common.generated_configuration_definitions

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

ase2sprkkr.common.grammar

Various pyparsing grammar elements and a few useful routines.

ase2sprkkr.common.init_tests

Routines and classes used in tests

ase2sprkkr.common.misc

Various classes and routines used thorough the package

ase2sprkkr.common.options

The classes for storing one configuration value.

ase2sprkkr.common.process_output_reader

Readers for processes outputs.

ase2sprkkr.common.repeated_configuration_containers

ase2sprkkr.common.subprocess

ase2sprkkr.common.tools

This module contain support for the tools

ase2sprkkr.common.unique_values

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

ase2sprkkr.common.value_definitions

ase2sprkkr.common.warnings

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

ase2sprkkr.common.test

ase2sprkkr.common.grammar_types

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