encyclopedia.py 11.8 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# Copyright 2018 Markus Scheidgen
#
# Licensed under the Apache License, Version 2.0 (the 'License');
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an'AS IS' BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from typing import Any

17
from nomad.normalizing.normalizer import Normalizer
18
from nomad.metainfo.encyclopedia import (
19
    section_encyclopedia,
20
21
22
23
24
    Material,
    Method,
    Properties,
    Calculation,
)
25
from nomad.parsing.legacy import Backend
26
27
28
29
30
31
32
33
34
35
36
37
38
from nomad.normalizing.encyclopedia.context import Context
from nomad.normalizing.encyclopedia.material import MaterialBulkNormalizer, Material2DNormalizer, Material1DNormalizer
from nomad.normalizing.encyclopedia.method import MethodDFTNormalizer, MethodGWNormalizer
from nomad.normalizing.encyclopedia.properties import PropertiesNormalizer
from nomad import config

J_to_Ry = 4.587425e+17


class EncyclopediaNormalizer(Normalizer):
    """
    This normalizer emulates the functionality of the old Encyclopedia backend.
    The data used by the encyclopedia have been assigned under new metainfo
39
    within a new section called "encyclopedia". In the future these separate
40
41
    metainfos could be absorbed into the existing metainfo hiearchy.
    """
42
    def __init__(self, backend: Backend):
43
        super().__init__(backend)
44
        self.backend: Backend = backend
45
46
47
48
49
50
51
52
53

    def calc_type(self, calc: Calculation) -> str:
        """Decides what type of calculation this is: single_point, md,
        geometry_optimization, etc.
        """
        calc_enums = Calculation.calculation_type.type
        calc_type = calc_enums.unavailable

        try:
54
            sccs = self.section_run.section_single_configuration_calculation
55
56
57
        except Exception:
            sccs = []
        try:
58
            frame_sequences = self.section_run.section_frame_sequence
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
        except Exception:
            frame_sequences = []

        n_scc = len(sccs)
        n_frame_seq = len(frame_sequences)

        # No sequences, only a few calculations
        if n_scc <= 3 and n_frame_seq == 0:
            program_name = self._backend["program_name"]
            if program_name == "elastic":
                # TODO move to taylor expansion as soon as data is correct in archive
                calc_type = calc_enums.elastic_constants
            else:
                calc_type = calc_enums.single_point

        # One sequence. Currently calculations with multiple sequences are
        # unsupported.
        elif n_frame_seq == 1:
            frame_seq = frame_sequences[0]

            # See if sampling_method is present
            try:
81
                section_sampling_method = frame_seq.frame_sequence_to_sampling_ref
82
83
84
85
86
87
88
89
90
            except KeyError:
                self.logger.info(
                    "Cannot determine encyclopedia run type because missing "
                    "value for frame_sequence_to_sampling_ref."
                )
                return calc_type

            # See if local frames are present
            try:
91
                frames = frame_seq.frame_sequence_local_frames_ref
92
93
94
95
96
97
98
99
100
101
            except KeyError:
                self.logger.info(
                    "section_frame_sequence_local_frames not found although a "
                    "frame_sequence exists."
                )
                return calc_type
            if len(frames) == 0:
                self.logger.info("No frames referenced in section_frame_sequence_local_frames.")
                return calc_type

102
            sampling_method = section_sampling_method.sampling_method
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

            if sampling_method == "molecular_dynamics":
                calc_type = calc_enums.molecular_dynamics
            if sampling_method == "geometry_optimization":
                calc_type = calc_enums.geometry_optimization
            if sampling_method == "taylor_expansion":
                calc_type = calc_enums.phonon_calculation

        calc.calculation_type = calc_type
        return calc_type

    def material_type(self, material: Material) -> tuple:
        # Try to fetch representative system
        system = None
        material_type = config.services.unavailable_value
        material_enums = Material.material_type.type
119
        try:
120
            system_idx = self.section_run.m_cache["representative_system_idx"]
121
122
123
        except (AttributeError, KeyError):
            pass
        else:
124
125
            # Try to find system type information from backend for the selected system.
            try:
126
127
                system = self.section_run.section_system[system_idx]
                stype = system.system_type
128
129
130
131
132
133
134
135
            except KeyError:
                pass
            else:
                if stype == material_enums.one_d or stype == material_enums.two_d:
                    material_type = stype
                # For bulk systems we also ensure that the symmetry information is available
                if stype == material_enums.bulk:
                    try:
136
                        system.section_symmetry[0]
137
138
139
140
141
142
143
144
145
146
147
                    except (KeyError, IndexError):
                        self.logger.info("Symmetry information is not available for a bulk system. No Encylopedia entry created.")
                    else:
                        material_type = stype

        material.material_type = material_type
        return system, material_type

    def method_type(self, method: Method) -> tuple:
        repr_method = None
        method_id = config.services.unavailable_value
148
        methods = self.section_run.section_method
149
150
151
152
        n_methods = len(methods)

        if n_methods == 1:
            repr_method = methods[0]
153
154
155
            method_id = repr_method.electronic_structure_method
            if method_id is None:
                method_id = config.services.unavailable_value
156
        elif n_methods > 1:
157
            for sec_method in methods:
158
                # GW
159
                electronic_structure_method = sec_method.electronic_structure_method
160
161
162
163
164
165
166
167
168
                if electronic_structure_method in {"G0W0", "scGW"}:
                    repr_method = sec_method
                    method_id = "GW"
                    break

                # Methods linked to each other through references. Get all
                # linked methods, try to get electronic_structure_method from
                # each.
                try:
169
                    refs = sec_method.section_method_to_method_refs
170
171
172
173
174
                except KeyError:
                    pass
                else:
                    linked_methods = [sec_method]
                    for ref in refs:
175
176
                        method_to_method_kind = ref.method_to_method_kind
                        method_to_method_ref = ref.method_to_method_ref
177
                        if method_to_method_kind == "core_settings":
178
                            linked_methods.append(method_to_method_ref)
179
180

                    for i_method in linked_methods:
181
182
                        electronic_structure_method = i_method.electronic_structure_method
                        if electronic_structure_method is not None:
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
                            repr_method = sec_method
                            method_id = electronic_structure_method

        method.method_type = method_id
        return repr_method, method_id

    def fill(self, context: Context):
        # Fill structure related metainfo
        struct: Any = None
        if context.material_type == Material.material_type.type.bulk:
            struct = MaterialBulkNormalizer(self.backend, self.logger)
        elif context.material_type == Material.material_type.type.two_d:
            struct = Material2DNormalizer(self.backend, self.logger)
        elif context.material_type == Material.material_type.type.one_d:
            struct = Material1DNormalizer(self.backend, self.logger)
        if struct is not None:
            struct.normalize(context)

        # Fill method related metainfo
        method = None
        if context.method_type == Method.method_type.type.DFT or context.method_type == Method.method_type.type.DFTU:
            method = MethodDFTNormalizer(self._backend, self.logger)
        elif context.method_type == Method.method_type.type.GW:
            method = MethodGWNormalizer(self._backend, self.logger)
        if method is not None:
            method.normalize(context)

        # Fill properties related metainfo
        properties = PropertiesNormalizer(self.backend, self.logger)
        properties.normalize(context)

    def normalize(self, logger=None) -> None:
        """The caller will automatically log if the normalizer succeeds or ends
        up with an exception.
        """
        try:
            super().normalize(logger)

            # Initialise metainfo structure
222
            sec_enc = self.backend.entry_archive.m_create(section_encyclopedia)
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
            material = sec_enc.m_create(Material)
            method = sec_enc.m_create(Method)
            sec_enc.m_create(Properties)
            calc = sec_enc.m_create(Calculation)

            # Determine run type, stop if unknown
            calc_type = self.calc_type(calc)
            if calc_type == config.services.unavailable_value:
                self.logger.info(
                    "Unsupported run type for encyclopedia, encyclopedia metainfo not created.",
                    enc_status="unsupported_calc_type",
                )
                return

            # Get the system type, stop if unknown
            material_enums = Material.material_type.type
            representative_system, material_type = self.material_type(material)
            if material_type != material_enums.bulk and material_type != material_enums.two_d and material_type != material_enums.one_d:
                self.logger.info(
242
                    "Unsupported material type for encyclopedia, encyclopedia metainfo not created.",
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
                    enc_status="unsupported_material_type",
                )
                return

            # Get the method type, stop if unknown
            representative_method, method_type = self.method_type(method)
            if method_type == config.services.unavailable_value:
                self.logger.info(
                    "Unsupported method type for encyclopedia, encyclopedia metainfo not created.",
                    enc_status="unsupported_method_type",
                )
                return

            # Get representative scc
            try:
258
259
                representative_scc_idx = self.section_run.m_cache["representative_scc_idx"]
                representative_scc = self.section_run.section_single_configuration_calculation[representative_scc_idx]
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
            except (KeyError, IndexError):
                representative_scc = None
                representative_scc_idx = None

            # Create one context that holds all details
            context = Context(
                material_type=material_type,
                method_type=method_type,
                calc_type=calc_type,
                representative_system=representative_system,
                representative_method=representative_method,
                representative_scc=representative_scc,
                representative_scc_idx=representative_scc_idx,
            )

            # Put the encyclopedia section into backend
            self.fill(context)
277

278
279
280
281
282
283
284
285
286
287
288
        except Exception:
            self.logger.error(
                "Failed to create an Encyclopedia entry due to an unhandlable exception.",
                enc_status="failure",
            )
            raise  # Reraise for the caller to log the exception as well
        else:
            self.logger.info(
                "Successfully created metainfo for Encyclopedia.",
                enc_status="success",
            )