aiida_alc_ins.workflows.force_constants

Resolve force constants from a CASTEP file, Phonopy files or a prepared node.

See ForceConstantsWorkChain. Consuming workflows expose its inputs under force_constants (see aiida_alc_ins.workflows.base).

WorkChain reference: https://aiida.readthedocs.io/projects/aiida-core/en/stable/topics/workflows/write.html

Attributes

Functions

read_castep_force_constants(...)

Read a CASTEP SinglefileData into a ForceConstantsData.

read_phonopy_force_constants(...)

Read Phonopy SinglefileData files into a ForceConstantsData.

Module Contents

aiida_alc_ins.workflows.force_constants.PHONOPY_READ_ERRORS
aiida_alc_ins.workflows.force_constants.read_castep_force_constants(castep_file: aiida.orm.SinglefileData) → aiida_alc_ins.data.ForceConstantsData | aiida.engine.ExitCode[source]

Read a CASTEP SinglefileData into a ForceConstantsData.

An unreadable or invalid file returns ExitCode(300). Other exceptions propagate.

aiida_alc_ins.workflows.force_constants.read_phonopy_force_constants(summary: aiida.orm.SinglefileData, force_constants: aiida.orm.SinglefileData | None = None, born: aiida.orm.SinglefileData | None = None) → aiida_alc_ins.data.ForceConstantsData | aiida.engine.ExitCode[source]

Read Phonopy SinglefileData files into a ForceConstantsData.

Each file is read from a temporary copy under its stored name, so Euphonic infers the force-constants format from the suffix. A missing or malformed file returns ExitCode(300). Other exceptions propagate.