ResultFile

class ase2sprkkr.result_files.result_files.ResultFile(definition=None, container=None, potential=None)[source]

Representation of a structured SPR-KKR result file.

Class hierarchy

Inheritance diagram of ase2sprkkr.result_files.result_files.ResultFile


Constructor

__init__(definition=None, container=None, potential=None)[source]
plot_parameters = {}
additional_actions = ()
read_from_file(file, clear_first=True, allow_dangerous=False, potential=None, *, allow_incomplete=False, report_invalid=None)[source]

Read result data and optionally associate its potential.

classmethod can_be_plotted()[source]
set_potential_filename(potential_filename)[source]
property potential_filename[source]
property potential[source]
property atoms
unknown_result_file_definition = <RESULT FILE None>
definitions = {'band_spc': <RESULT FILE BAND_SPC>, 'bsf': <RESULT FILE BSF>, 'dat': <RESULT FILE JXC>, 'dos': <RESULT FILE DOS>, 'jxc': <RESULT FILE JXC>, 'rat': <RESULT FILE RAT>, 'sfn': <RESULT FILE SFN>, 'spc': <RESULT FILE ARPES>, 'spleed_spc': <RESULT FILE SPLEED_SPC>}
classmethod definition(self)[source]
classmethod from_file(filename, first_try=None, try_only=None, unknown=None, potential=None)[source]

Read SPRKKR result file (DOS, BSF….). The type of content of the result file is guessed from the content, however you can get hint what to try first or force to read only certain file type(s).

Parameters:
  • filename – The file to read

  • first_try – Result file type(s) to try first. If omitted, the type is guessed from the file extension.

  • try_only – Result file type(s) allowed to be read. None means any known result file type.

  • unknown – If True, fall back to an unknown result file: its header is parsed and the remaining content is stored as text. If False, raise an exception if no known (and allowed) file type is recognized. None means True if try_only is None, False otherwise.

  • potential – A Potential or its filename. If omitted, it is looked up lazily from the result filename when it is needed.

_abc_impl = <_abc._abc_data object>