InputParametersDefinition

class ase2sprkkr.input_parameters.input_parameters_definitions.InputParametersDefinition(name, members=[], written_name=None, info=None, description=None, is_optional=None, is_hidden=False, is_expert=False, experimental=False, has_hidden_members=False, name_in_grammar=None, force_order=None, name_regex=False, result_class=None, is_repeated=False, repeated_delimiter=None, repeated_count=None, repeated_with_name=False, write_condition=None, warning_condition=None, validators=())[source]

Syntax and parameter semantics of one SPR-KKR input-file schema.

Class hierarchy

Inheritance diagram of ase2sprkkr.input_parameters.input_parameters_definitions.InputParametersDefinition


Constructor

Parameters:

validators (Callable[[Any, Any, str], Any] | Iterable[Callable[[Any, Any, str], Any]] | None)

__init__(name, members=[], written_name=None, info=None, description=None, is_optional=None, is_hidden=False, is_expert=False, experimental=False, has_hidden_members=False, name_in_grammar=None, force_order=None, name_regex=False, result_class=None, is_repeated=False, repeated_delimiter=None, repeated_count=None, repeated_with_name=False, write_condition=None, warning_condition=None, validators=())
Parameters:

validators (Callable[[Any, Any, str], Any] | Iterable[Callable[[Any, Any, str], Any]] | None)

_task_definition = None

1 task declared together with this schema.

This is declaration-time metadata for the simple case where one input schema represents exactly one task. Schemas shared by multiple tasks leave it as None and override task_definition_name() using their values.

The association is internal and must not be changed after registration.

Type:

Canonical 1

is_user_defined = True

Whether the definition comes from user code.

Standalone definitions default to True; registration overrides this according to the defining module’s origin.

_derived_from_name = None

If one copies the definition, it should be listed under its new name, but retain the original name as well, to retain the information, to which “task” it originally belongs

child_class

alias of ase2sprkkr.input_parameters.input_parameters_definitions.InputSectionDefinition

result_class

alias of ase2sprkkr.input_parameters.input_parameters.InputParameters

static custom_class(name, container)
configuration_type_name = 'INPUT PARAMETERS'

Name of the container type in the runtime documentation

task_selectors = None

Native TASK selectors, defaulting to the IPD name.

A string denotes one selector; an iterable denotes multiple selectors. Like other registration metadata, this must not change once the singleton registry has constructed the cached selector map and preparse grammar.

accepted_task_selectors()[source]
from_file(cls, file, allow_dangerous=False, *, allow_incomplete=False, report_invalid=None)[source]

Read one input; on the class autodetect an IPD, on an instance use it.

Read a bounded snapshot of the input once, independently of path/stream. A missing TASK selector selects SCF, not an ADSI-derived definition.

parse_return(val, return_value_only=True)[source]
read_from_file(file, allow_dangerous=False, *, filename=None, allow_incomplete=False, report_invalid=None, **kwargs)[source]
task_definition_name(parameters)[source]

Return the ASE2SPRKKR task name represented by parameters.

The standard one-schema/one-task case is answered directly by the schema declaration. Shared schemas override this method and derive the identity from concrete parameter values. Resolving the returned name to a TaskDefinition remains the responsibility of TaskRegistry.

initialize_from_result(parameters, result)[source]

Initialize instance-specific defaults derived from a previous result.

input_files(parameters, directory)[source]

Return schema-specific auxiliary input files.

output_files(parameters, directory)[source]

Return schema-specific output files.

cache_files(parameters, directory)[source]

Return schema-specific optional cache files.

classmethod custom_value_grammar()[source]
delimiter
Parameters:

name (Optional[str])

Return type:

ParserElement

_generic_info()[source]
copy(*args, new_schema=False, **kwargs)[source]
property derived_from_name
is_derived_definition()[source]
property display_name
info(generic=True)[source]