aiida_vasp.parsers.content_parsers.incar

The INCAR parser interface.

Contains the parsing interfaces to parsevasp used to parse INCAR content.

Module Contents

Classes

IncarParser

The parser interface that enables parsing of INCAR content.

API

class aiida_vasp.parsers.content_parsers.incar.IncarParser(*args, validate_tags: bool = True, **kwargs)

Bases: aiida_vasp.parsers.content_parsers.base.BaseFileParser

The parser interface that enables parsing of INCAR content.

The parser is triggered by using the incar quantity key.

Initialization

DEFAULT_SETTINGS = None

PARSABLE_QUANTITIES = None

_init_from_handler(handler: io.TextIO) → None

Initialize a parsevasp object of Incar using a file like handler.

Parameters:

handler (file-like object) – A file like object that provides the necessary INCAR content to be parsed.

_init_from_data(data: aiida.orm.Dict) → None

Initialize using an AiiDA Dict instance.

Parameters:

data (object) – A valid AiiDA Dict object.

property incar: dict | None

Return the parameters in the INCAR.

Returns:

A dictionary containing the parameter tags as keys and its settings as values. None is returned if the quantity can not be parsed.

Return type:

dict or None

_content_data_to_content_parser() → parsevasp.incar.Incar

Convert an AiiDA Dict to a content parser instance of Incar from parsevasp.

Returns:

An instance of Incar from parsevasp.

Return type:

object