inputparsing.py 14.1 KB
Newer Older
1
import numpy as np
2
3
import logging
from collections import defaultdict
4
logger = logging.getLogger("nomad")
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42


#===============================================================================
class CP2KInput(object):
    """The contents of a CP2K simulation including default values and default
    units from the version-specific xml file.
    """

    def __init__(self, root_section):
        self.root_section = root_section

    @staticmethod
    def decode_cp2k_unit(unit):
        """Given a CP2K unit name, decode it as Pint unit definition.
        """
        map = {
            # Length
            "bohr": "bohr",
            "m": "meter",
            "pm": "picometer",
            "nm": "nanometer",
            "angstrom": "angstrom",

            # Angle
            "rad": "radian",
            "deg": "degree",

            #Energy
            "Ry": "rydberg"
        }
        pint_unit = map.get(unit)
        if pint_unit:
            return pint_unit
        else:
            logger.error("Unknown CP2K unit definition '{}'.".format(unit))

    def set_parameter(self, path, value):
        parameter, section = self.get_parameter_and_section(path)
43
44
45
46
47
48
49
50
        if section is None:
            message = "The CP2K input does not contain a section {}".format(path)
            logger.warning(message)
        if parameter is None:
            message = "The CP2K input section {} does not contain a SECTION_PARAMETER".format(path)
            logger.warning(message)
        else:
            parameter.value = value
51
52
53

    def set_keyword(self, path, value):
        keyword, section = self.get_keyword_and_section(path)
54
        # If keyword found, put data in there
55
56
        if keyword and section:
            keyword.value = value
57
        # Keyword not found in the input tree, assuming it is a default keyword
58
59
60
        elif section is not None:
            split_path = path.rsplit("/", 1)
            keyword = split_path[1]
61
62
63
64
65
66
            if section.default_keyword is not None:
                # print "Saving default keyword at path '{}'".format(path)
                section.default_keyword.value += keyword + " " + value + "\n"
            else:
                message = "The CP2K input does not contain the keyword {}, and there is no default keyword for the section {}".format(path, split_path[0])
                logger.warning(message)
67
68
69
70
71
72
73

    def get_section(self, path):
        split_path = path.split("/")
        section = self.root_section
        for part in split_path:
            section = section.get_subsection(part)
            if not section:
74
75
                message = "The CP2K input does not contain the section {}".format(path)
                logger.warning(message)
76
77
78
79
80
81
82
83
                return None
        return section

    def get_keyword_and_section(self, path):
        split_path = path.rsplit("/", 1)
        keyword = split_path[1]
        section_path = split_path[0]
        section = self.get_section(section_path)
84
85
86
87
88
89

        if section is None:
            message = "The CP2K input does not contain the section {}".format(path)
            logger.warning(message)
            return (None, None)

Lauri Himanen's avatar
Lauri Himanen committed
90
        keyword = section.get_keyword_object(keyword)
91
92
        if keyword and section:
            return (keyword, section)
93
        else:
94
95
            return (None, section)

96
97
98
99
100
101
    def get_keyword(self, path, format_value=True):
        if format_value:
            return self.get_keyword_value_formatted(path)
        else:
            return self.get_keyword_value_raw(path)

Lauri Himanen's avatar
Lauri Himanen committed
102
103
    def get_keyword_value_formatted(self, path):
        """
104
105
106
        """
        keyword, section = self.get_keyword_and_section(path)
        if keyword:
Lauri Himanen's avatar
Lauri Himanen committed
107
108
            return keyword.get_value_formatted()

109
    def get_keyword_value_raw(self, path):
Lauri Himanen's avatar
Lauri Himanen committed
110
111
112
113
        """
        """
        keyword, section = self.get_keyword_and_section(path)
        if keyword:
114
            return keyword.get_value_raw()
115
116

    def get_default_keyword(self, path):
117
        return self.get_section(path).default_keyword.value
118
119
120

    def set_section_accessed(self, path):
        section = self.get_section(path)
121
122
123
124
125
        if section:
            section.accessed = True
        else:
            message = "The CP2K input does not contain the section {}".format(path)
            logger.warning(message)
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

    def get_keyword_default(self, path):
        keyword, section = self.get_keyword_and_section(path)
        if keyword:
            return keyword.default_value

    def get_default_unit(self, path):
        keyword, section = self.get_keyword_and_section(path)
        if keyword:
            return keyword.default_unit

    def get_unit(self, path):
        keyword, section = self.get_keyword_and_section(path)
        if keyword:
            return keyword.get_unit()

    def get_parameter_and_section(self, path):
        section = self.get_section(path)
144
145
146
147
148
149
150
        if section is None:
            return (None, None)
        if section.section_parameter is not None:
            parameter = section.section_parameter
            return (parameter, section)
        else:
            return (None, section)
151
152
153
154
155
156
157
158
159
160
161

    def get_parameter(self, path):
        parameter, section = self.get_parameter_and_section(path)
        if parameter:
            if parameter.value:
                return parameter.value
            elif section and section.accessed:
                return parameter.lone_value


#===============================================================================
162
163
class InputObject(object):
    """Base class for all kind of data elements in the CP2K input.
164
    """
165
    __slots__ = ['name', 'value', 'default_value', 'description', 'data_type', 'data_dimension']
166

167
168
    def __init__(self, name):
        self.name = name
169
        self.value = None
170
171
172
173
174
        self.description = None
        self.data_type = None
        self.data_dimension = None
        self.default_value = None

175
176
177
178
179
180
181
182
183
184
185
186
187
188
189

#===============================================================================
class Keyword(InputObject):
    """Information about a keyword in a CP2K calculation.
    """
    __slots__ = ['unit', 'value_no_unit', 'default_unit', 'default_name']

    def __init__(self, name, default_value,  default_unit, default_name):
        super(Keyword, self).__init__(name)
        self.unit = None
        self.value_no_unit = None
        self.default_unit = default_unit
        self.default_value = default_value
        self.default_name = default_name

190
    def get_value_raw(self):
Lauri Himanen's avatar
Lauri Himanen committed
191
192
193
194
195
196
        """Returns the unformatted value of this keyword. This is exactly what
        was set by the used in the input as a string.
        """
        return self.value

    def get_value_formatted(self):
197
198
        """Returns the value stored in this keyword by removing the possible
        unit definition and formatting the string into the correct data type.
199
        """
200
        # Decode the unit and the value if not done before
Lauri Himanen's avatar
Lauri Himanen committed
201
        proper_value = None
202
203
204
205
206
207
208
        if self.default_unit:
            if not self.value_no_unit:
                self.decode_cp2k_unit_and_value()
        if self.value_no_unit is not None:
            proper_value = self.value_no_unit
        else:
            proper_value = self.value
Lauri Himanen's avatar
Lauri Himanen committed
209
210
        if proper_value is None:
            proper_value = self.default_value
211
212
        if proper_value is None:
            return None
213

214
215
        returned = None
        dim = int(self.data_dimension)
216
        splitted = proper_value.split()
217
218
219
        if len(splitted) != dim:
            logger.error("The dimensions of the CP2K input parameter {} do not match the specification in the XML file.".format(self.name))

220
221
222
        if dim == 1:
            try:
                if self.data_type == "integer":
223
                    returned = int(proper_value)
224
                elif self.data_type == "real":
225
                    returned = float(proper_value)
226
                elif self.data_type == "word":
227
                    returned = str(proper_value)
228
                elif self.data_type == "keyword":
229
                    returned = str(proper_value)
230
                elif self.data_type == "string":
231
                    returned = str(proper_value)
232
                elif self.data_type == "logical":
233
                    returned = str(proper_value)
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
                else:
                    logger.error("Unknown data type '{}'".format(self.data_type))
                    return
            except TypeError:
                logger.error("The CP2K input parameter {} could not be converted to the type specified in the XML file.".format(self.name))
                return
        else:
            try:
                if self.data_type == "integer":
                    returned = np.array([int(x) for x in splitted])
                elif self.data_type == "real":
                    returned = np.array([float(x) for x in splitted])
                elif self.data_type == "word":
                    returned = np.array([str(x) for x in splitted])
                elif self.data_type == "keyword":
                    returned = np.array([str(x) for x in splitted])
                elif self.data_type == "string":
                    returned = np.array([str(x) for x in splitted])
                elif self.data_type == "logical":
                    returned = np.array([str(x) for x in splitted])
                else:
                    logger.error("Unknown data type '{}'".format(self.data_type))
                    return
            except TypeError:
                logger.error("The CP2K input parameter {} could not be converted to the type specified in the XML file.".format(self.name))
259
260
261
                return

        return returned
262

263
    def determine_value_and_unit(self):
264
265
266
267
268
269
270
271
272
273
274
        """If the units of this value can be changed, return a value and the
        unit separately.
        """
        if self.default_unit:
            if not self.value_no_unit:
                self.decode_cp2k_unit_and_value()
            return self.value_no_unit
        else:
            return self.value

    def get_unit(self):
275
276

        # Decode the unit and the value if not done before
277
278
279
280
281
282
        if self.default_unit:
            if not self.unit:
                self.decode_cp2k_unit_and_value()
            return self.unit
        else:
            logger.error("The keyword '{}' does not have a unit.".format(self.default_name))
283
            return None
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303

    def decode_cp2k_unit_and_value(self):
        """Given a CP2K unit name, decode it as Pint unit definition.
        """
        splitted = self.value.split(None, 1)
        unit_definition = splitted[0]
        if unit_definition.startswith('[') and unit_definition.endswith(']'):
            unit_definition = unit_definition[1:-1]
            self.unit = CP2KInput.decode_cp2k_unit(self.default_unit)
            self.value_no_unit = splitted[1]
        elif self.default_unit:
            logger.debug("No special unit definition found, returning default unit.")
            self.unit = CP2KInput.decode_cp2k_unit(self.default_unit)
            self.value_no_unit = self.value
        else:
            logger.debug("The value has no unit, returning bare value.")
            self.value_no_unit = self.value


#===============================================================================
304
class Section(object):
305
306
    """An input section in a CP2K calculation.
    """
307
    __slots__ = ['accessed', 'name', 'keywords', 'default_keyword_names', 'default_keyword', 'section_parameter', 'sections', 'description']
308
309
310
311
312

    def __init__(self, name):
        self.accessed = False
        self.name = name
        self.keywords = defaultdict(list)
313
314
        self.default_keyword_names = []
        self.default_keyword = None
315
316
        self.section_parameter = None
        self.sections = defaultdict(list)
317
        self.description = None
318

Lauri Himanen's avatar
Lauri Himanen committed
319
    def get_keyword_object(self, name):
320
321
322
323
324
325
326
        keyword = self.keywords.get(name)
        if keyword:
            if len(keyword) == 1:
                return keyword[0]
            else:
                logger.error("The keyword '{}' in '{}' does not exist or has too many entries.".format(name, self.name))

Lauri Himanen's avatar
Lauri Himanen committed
327
328
329
330
331
332
333
334
335
    def get_keyword_value_formatted(self, name):
        """Returns the keyword value formatted to the correct shape and type,
        and returns the default value if nothing was specified.
        """
        keyword_object = self.get_keyword_object(name)
        if keyword_object is not None:
            value = keyword_object.get_value_formatted()
            return value

336
    def get_keyword_value_raw(self, name):
Lauri Himanen's avatar
Lauri Himanen committed
337
338
339
340
        """Returns the keyword value as a raw string as specfied by the used.
        """
        keyword_object = self.get_keyword_object(name)
        if keyword_object is not None:
341
            return keyword_object.get_value_raw()
Lauri Himanen's avatar
Lauri Himanen committed
342

343
344
345
346
347
348
349
350
351
352
    def get_subsection(self, name):
        subsection = self.sections.get(name)
        if subsection:
            if len(subsection) == 1:
                return subsection[0]
            else:
                logger.error("The subsection '{}' in '{}' has too many entries.".format(name, self.name))
        else:
            logger.error("The subsection '{}' in '{}' does not exist.".format(name, self.name))

Lauri Himanen's avatar
Lauri Himanen committed
353
354
355
356
357
358
359
360
361
362
    def get_section_parameter(self):
        """Get the section parameter, or if not specified the lone keyword
        value.
        """
        if self.section_parameter is not None:
            value = self.section_parameter.value
            if value is None:
                value = self.section_parameter.lone_keyword_value
            return value.upper()

363
364

#===============================================================================
365
class SectionParameters(InputObject):
366
367
368
369
370
    """Section parameters in a CP2K calculation.

    Section parameters are the short values that can be added right after a
    section name, e.g. &PRINT ON, where ON is the section parameter.
    """
371
    __slots__ = ['lone_keyword_value']
372

373
374
    def __init__(self, default_value, lone_keyword_value):
        super(SectionParameters, self).__init__("SECTION_PARAMETERS")
375
        self.default_value = default_value
376
377
378
379
380
381
382
        self.lone_keyword_value = lone_keyword_value


#===============================================================================
class DefaultKeyword(InputObject):
    """Default keyword in the CP2K input.
    """
383
384
    __slots__ = ['lone_value']

385
386
387
388
    def __init__(self):
        super(DefaultKeyword, self).__init__("DEFAULT_KEYWORD")
        self.lone_value = None
        self.value = ""