config.py 12 KB
Newer Older
Markus Scheidgen's avatar
Markus Scheidgen committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
# 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.

15
'''
Markus Scheidgen's avatar
Markus Scheidgen committed
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
This module describes all configurable parameters for the nomad python code. The
configuration is used for all executed python code including API, worker, CLI, and other
scripts. To use the configuration in your own scripts or new modules, simply import
this module.

All parameters are structured into objects for two reasons. First, to have
categories. Second, to allow runtime manipulation that is not effected
by python import logic. The categories are choosen along infrastructure components:
``mongo``, ``elastic``, etc.

This module also provides utilities to read the configuration from environment variables
and .yaml files. This is done automatically on import. The precedence is env over .yaml
over defaults.

.. autoclass:: nomad.config.NomadConfig
.. autofunction:: nomad.config.apply
.. autofunction:: nomad.config.load_config
33
'''
Markus Scheidgen's avatar
Markus Scheidgen committed
34

Markus Scheidgen's avatar
Markus Scheidgen committed
35
import logging
36
37
38
import os
import os.path
import yaml
Markus Scheidgen's avatar
Markus Scheidgen committed
39
40
import warnings

Markus Scheidgen's avatar
Markus Scheidgen committed
41
42
43
from nomad import gitinfo


Markus Scheidgen's avatar
Markus Scheidgen committed
44
45
46
warnings.filterwarnings("ignore", message="numpy.dtype size changed")
warnings.filterwarnings("ignore", message="numpy.ufunc size changed")

47

48
class NomadConfig(dict):
49
    '''
Markus Scheidgen's avatar
Markus Scheidgen committed
50
51
    A class for configuration categories. It is a dict subclass that uses attributes as
    key/value pairs.
52
    '''
53
54
55
56
57
58
59
60
61
62
63
    def __init__(self, **kwargs):
        super().__init__(**kwargs)

    def __getattr__(self, name):
        if name in self:
            return self[name]
        else:
            raise AttributeError("No such attribute: " + name)

    def __setattr__(self, name, value):
        self[name] = value
64

65
66
67
68
69
    def __delattr__(self, name):
        if name in self:
            del self[name]
        else:
            raise AttributeError("No such attribute: " + name)
70
71


72
73
CELERY_WORKER_ROUTING = 'worker'
CELERY_QUEUE_ROUTING = 'queue'
74

75
76
77
78
79
rabbitmq = NomadConfig(
    host='localhost',
    user='rabbitmq',
    password='rabbitmq'
)
80

81

82
83
def rabbitmq_url():
    return 'pyamqp://%s:%s@%s//' % (rabbitmq.user, rabbitmq.password, rabbitmq.host)
84

Lauri Himanen's avatar
Lauri Himanen committed
85

86
87
88
89
celery = NomadConfig(
    max_memory=64e6,  # 64 GB
    timeout=1800,  # 1/2 h
    acks_late=True,
90
    routing=CELERY_QUEUE_ROUTING,
91
92
93
94
95
    priorities={
        'Upload.process_upload': 5,
        'Upload.delete_upload': 9,
        'Upload.publish_upload': 10
    }
96
)
97

98
99
100
101
fs = NomadConfig(
    tmp='.volumes/fs/tmp',
    staging='.volumes/fs/staging',
    public='.volumes/fs/public',
102
    local_tmp='/tmp',
103
104
    prefix_size=2,
    working_directory=os.getcwd()
105
)
106

107
108
109
110
111
elastic = NomadConfig(
    host='localhost',
    port=9200,
    index_name='nomad_fairdi_calcs'
)
112

113
keycloak = NomadConfig(
114
    server_url='https://repository.nomad-coe.eu/fairdi/keycloak/auth/',
115
116
117
    realm_name='fairdi_nomad_test',
    username='admin',
    password='password',
118
119
120
    client_id='nomad_public',
    client_secret=None,
    oasis=False)
121

122
123
124
125
126
mongo = NomadConfig(
    host='localhost',
    port=27017,
    db_name='nomad_fairdi'
)
127

128
129
130
131
132
133
logstash = NomadConfig(
    enabled=True,
    host='localhost',
    tcp_port='5000',
    level=logging.DEBUG
)
Markus Scheidgen's avatar
Markus Scheidgen committed
134

135
136
137
services = NomadConfig(
    api_host='localhost',
    api_port=8000,
Markus Scheidgen's avatar
Markus Scheidgen committed
138
    api_base_path='/fairdi/nomad/latest',
139
    api_secret='defaultApiSecret',
140
    api_chaos=0,
141
    admin_user_id='00000000-0000-0000-0000-000000000000',
142
    not_processed_value='not processed',
143
    unavailable_value='unavailable',
144
    https=False,
145
    upload_limit=10,
146
147
    force_raw_file_decoding=False,
    download_scan_size=500,
148
    download_scan_timeout=u'30m',
149
150
)

Markus Scheidgen's avatar
Markus Scheidgen committed
151
152
153
154
tests = NomadConfig(
    default_timeout=30
)

155

156
def api_url(ssl: bool = True):
157
    return '%s://%s/%s/api' % (
158
        'https' if services.https and ssl else 'http',
159
160
        services.api_host.strip('/'),
        services.api_base_path.strip('/'))
161
162


163
164
165
166
167
168
def gui_url():
    base = api_url(True)[:-3]
    if base.endswith('/'):
        base = base[:-1]
    return '%s/gui' % base

169

170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
def check_config():
    """Used to check that the current configuration is valid. Should only be
    called once after the final config is loaded.

    Raises:
        AssertionError: if there is a contradiction or invalid values in the
            config file settings.
    """
    # The AFLOW symmetry information is checked once on import
    proto_symmetry_tolerance = normalize.prototype_symmetry_tolerance
    symmetry_tolerance = normalize.symmetry_tolerance
    if proto_symmetry_tolerance != symmetry_tolerance:
        raise AssertionError(
            "The AFLOW prototype information is outdated due to changed tolerance "
            "for symmetry detection. Please update the AFLOW prototype information "
            "by running the CLI command 'nomad admin ops prototype-update "
            "--matches-only'."
        )


190
191
192
193
mail = NomadConfig(
    enabled=False,
    with_login=False,
    host='',
Markus Scheidgen's avatar
Markus Scheidgen committed
194
    port=8995,
195
196
    user='',
    password='',
197
198
    from_address='webmaster@nomad-coe.eu',
    cc_address='webmaster@nomad-coe.eu'
199
200
201
)

normalize = NomadConfig(
202
203
    # The system size limit for running the dimensionality analysis. For very
    # large systems the dimensionality analysis will get too expensive.
204
    system_classification_with_clusters_threshold=64,
205
    # Symmetry tolerance controls the precision used by spglib in order to find
206
207
    # symmetries. The atoms are allowed to move 1/2*symmetry_tolerance from
    # their symmetry positions in order for spglib to still detect symmetries.
Lauri Himanen's avatar
Merged.    
Lauri Himanen committed
208
209
210
    # The unit is angstroms. The value of 0.1 is used e.g. by Materials Project
    # according to
    # https://pymatgen.org/pymatgen.symmetry.analyzer.html#pymatgen.symmetry.analyzer.SpacegroupAnalyzer
211
    symmetry_tolerance=0.1,
Lauri Himanen's avatar
Merged.    
Lauri Himanen committed
212
213
    # The symmetry tolerance used in aflow prototype matching. Should only be
    # changed before re-running the prototype detection.
214
    prototype_symmetry_tolerance=0.1,
215
216
217
218
219
220
    # Maximum number of atoms in the single cell of a 2D material for it to be
    # considered valid.
    max_2d_single_cell_size=7,
    # The distance tolerance between atoms for grouping them into the same
    # cluster. Used in detecting system type.
    cluster_threshold=3.1,
221
    # Defines the "bin size" for rounding cell angles for the material hash
222
223
224
225
226
    angle_rounding=float(10.0),  # unit: degree
    # The threshold for a system to be considered "flat". Used e.g. when
    # determining if a 2D structure is purely 2-dimensional to allow extra rigid
    # transformations that are improper in 3D but proper in 2D.
    flat_dim_threshold=0.1,
227
228
229
230
    # The threshold for point equality in k-space. Unit: 1/m.
    k_space_precision=150e6,
    # The energy threshold for how much a band can be on top or below the fermi
    # level in order to detect a gap. k_B x T at room temperature. Unit: Joule
231
    fermi_level_precision=300 * 1.38064852E-23,
232
233
    springer_db_path=os.path.join(
        os.path.dirname(os.path.abspath(__file__)),
234
235
        'normalizing/data/springer.msg'
    )
236
237
238
239
240
)

client = NomadConfig(
    user='leonard.hofstadter@nomad-fairdi.tests.de',
    password='password',
241
    url='http://repository.nomad-coe.eu/app/api'
242
243
)

244
245
246
247
248
249
250
251
datacite = NomadConfig(
    mds_host='https://mds.datacite.org',
    enabled=False,
    prefix='10.17172',
    user='*',
    password='*'
)

252
version = '0.8.0'
253
commit = gitinfo.commit
254
release = 'devel'
255
default_domain = 'dft'
256
service = 'unknown nomad service'
257
auxfile_cutoff = 100
258
parser_matching_size = 9128
259
console_log_level = logging.WARNING
260
max_upload_size = 32 * (1024 ** 3)
261
raw_file_strip_cutoff = 1000
262
use_empty_parsers = False
263
reprocess_unmatched = True
Lauri Himanen's avatar
Merged.    
Lauri Himanen committed
264

265

266
267
def normalize_loglevel(value, default_level=logging.INFO):
    plain_value = value
268
269
270
271
272
273
    if plain_value is None:
        return default_level
    else:
        try:
            return int(plain_value)
        except ValueError:
274
            return getattr(logging, plain_value)
275
276


277
transformations = {
278
279
    'console_log_level': normalize_loglevel,
    'logstash_level': normalize_loglevel
280
}
Markus Scheidgen's avatar
Markus Scheidgen committed
281

Markus Scheidgen's avatar
Markus Scheidgen committed
282

283
284
285
286
# use std python logger, since logging is not configured while loading configuration
logger = logging.getLogger(__name__)


287
def apply(key, value) -> None:
288
    '''
289
290
291
    Changes the config according to given key and value. The keys are interpreted as paths
    to config values with ``_`` as a separator. E.g. ``fs_staging`` leading to
    ``config.fs.staging``
292
    '''
293
294
295
    path = list(reversed(key.split('_')))
    child_segment = None
    current_value = None
296
    child_config = globals()
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
    child_key = None

    try:
        while len(path) > 0:
            if child_segment is None:
                child_segment = path.pop()
            else:
                child_segment += '_' + path.pop()

            if child_segment in child_config:
                current_value = child_config[child_segment]

            if current_value is None:
                if len(path) == 0:
                    raise KeyError
312
313

                continue
314
315
            if isinstance(current_value, NomadConfig):
                child_config = current_value
316
                current_value = None
317
318
319
320
                child_segment = None
            else:
                if len(path) > 0:
                    raise KeyError()
Markus Scheidgen's avatar
Markus Scheidgen committed
321
322
323

                child_key = child_segment
                break
324
325
326
327

        if child_key is None or current_value is None:
            raise KeyError()
    except KeyError:
Markus Scheidgen's avatar
Markus Scheidgen committed
328
        return
329
330
331
332
333
334
335
336
337
338
339

    if not isinstance(value, type(current_value)):
        try:
            value = transformations.get(key, type(current_value))(value)
        except Exception as e:
            logger.error(
                'config key %s value %s has wrong type: %s' % (key, str(value), str(e)))

    child_config[child_key] = value


Markus Scheidgen's avatar
Markus Scheidgen committed
340
def load_config(config_file: str = os.environ.get('NOMAD_CONFIG', 'nomad.yaml')) -> None:
341
    '''
Markus Scheidgen's avatar
Markus Scheidgen committed
342
343
344
345
346
    Loads the configuration from the ``config_file`` and environment.

    Arguments:
        config_file: Override the configfile, default is file stored in env variable
            NOMAD_CONFIG or ``nomad.yaml``.
347
    '''
348
    # load yaml and override defaults (only when not in test)
349
350
351
    if os.path.exists(config_file):
        with open(config_file, 'r') as stream:
            try:
352
                config_data = yaml.load(stream, Loader=getattr(yaml, 'FullLoader'))
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
            except yaml.YAMLError as e:
                logger.error('cannot read nomad config', exc_info=e)

        def adapt(config, new_config, child_key=None):
            for key, value in new_config.items():
                if key in config:
                    if child_key is None:
                        qualified_key = key
                    else:
                        qualified_key = '%s_%s' % (child_key, key)

                    current_value = config[key]
                    if isinstance(value, dict) and isinstance(current_value, NomadConfig):
                        adapt(current_value, value, qualified_key)
                    else:
                        if not isinstance(value, type(current_value)):
                            try:
                                value = transformations.get(qualified_key, type(current_value))(value)
                            except Exception as e:
                                logger.error(
                                    'config key %s value %s has wrong type: %s' % (key, str(value), str(e)))
                        else:
                            config[key] = value
376
                            logger.info('override config key %s with value %s' % (key, str(value)))
377
378
379
380
381
                else:
                    logger.error('config key %s does not exist' % key)

        adapt(globals(), config_data)

Markus Scheidgen's avatar
Markus Scheidgen committed
382
    # load env and override yaml and defaults
383
384
385
386
387
    kwargs = {
        key[len('NOMAD_'):].lower(): value
        for key, value in os.environ.items()
        if key.startswith('NOMAD_')
    }
388

389
    for key, value in kwargs.items():
390
        apply(key, value)
391
392
393


load_config()
Lauri Himanen's avatar
Merged.    
Lauri Himanen committed
394
check_config()