/
interactive.py
585 lines (485 loc) · 20.9 KB
/
interactive.py
1
2
3
4
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
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
222
223
224
225
226
227
228
229
230
231
232
233
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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
# coding: utf-8
# Copyright (c) Max-Planck-Institut für Eisenforschung GmbH - Computational Materials Design (CM) Department
# Distributed under the terms of "New BSD License", see the LICENSE file.
import numpy as np
from pyiron_base import Settings, InteractiveBase
from pyiron.atomistics.structure.atoms import Atoms
from pyiron.atomistics.structure.periodic_table import PeriodicTable
from pyiron.atomistics.job.atomistic import AtomisticGenericJob, GenericOutput
from collections import defaultdict
__author__ = "Osamu Waseda, Jan Janssen"
__copyright__ = (
"Copyright 2020, Max-Planck-Institut für Eisenforschung GmbH - "
"Computational Materials Design (CM) Department"
)
__version__ = "1.0"
__maintainer__ = "Jan Janssen"
__email__ = "janssen@mpie.de"
__status__ = "development"
__date__ = "Sep 1, 2017"
s = Settings()
class GenericInteractive(AtomisticGenericJob, InteractiveBase):
def __init__(self, project, job_name):
super(GenericInteractive, self).__init__(project, job_name)
self.output = GenericInteractiveOutput(job=self)
self._structure_previous = None
self._structure_current = None
self._interactive_enforce_structure_reset = False
self._interactive_grand_canonical = False
self._interactive_fetch_completed = True
self._interactive_species_lst = np.array([])
self._periodic_table = PeriodicTable()
self.interactive_input_functions = {'index': self.interactive_index_organizer,
'cell': self.interactive_cell_organizer,
'positions': self.interactive_positions_organizer,
'magnetic_moments': self.interactive_magmom_organizer}
self.interactive_output_functions = {'cells': self.interactive_cells_getter,
'energy_pot': self.interactive_energy_pot_getter,
'energy_tot': self.interactive_energy_tot_getter,
'forces': self.interactive_forces_getter,
'positions': self.interactive_positions_getter,
'pressures': self.interactive_pressures_getter,
'stress': self.interactive_stress_getter,
'steps': self.interactive_steps_getter,
'temperature': self.interactive_temperatures_getter,
'indices': self.interactive_indices_getter,
'computation_time': self.interactive_computation_time_getter,
'unwrapped_positions': self.interactive_unwrapped_positions_getter,
'atom_spin_constraints': self.interactive_atom_spin_constraints_getter,
'atom_spins': self.interactive_atom_spins_getter,
'magnetic_forces': self.interactive_magnetic_forces_getter,
'volume': self.interactive_volume_getter}
self.interactive_cache = defaultdict(list)
@property
def interactive_enforce_structure_reset(self):
return self._interactive_enforce_structure_reset
@interactive_enforce_structure_reset.setter
def interactive_enforce_structure_reset(self, reset):
if not isinstance(reset, bool):
raise AssertionError()
self._interactive_enforce_structure_reset = reset
@property
def initial_structure(self):
return AtomisticGenericJob.structure.fget(self)
@property
def current_structure(self):
return self.structure
@current_structure.setter
def current_structure(self, structure):
self.structure = structure
@property
def structure(self):
if self._structure_current is not None:
return self._structure_current
elif (
self.server.run_mode.interactive
or self.server.run_mode.interactive_non_modal
):
self._structure_current = AtomisticGenericJob.structure.fget(self)
return self._structure_current
else:
return AtomisticGenericJob.structure.fget(self)
@structure.setter
def structure(self, structure):
if (
self.server.run_mode.interactive
or self.server.run_mode.interactive_non_modal
):
# only overwrite the initial structure if it is not set already.
if AtomisticGenericJob.structure.fget(self) is None:
AtomisticGenericJob.structure.fset(self, structure.copy())
self._structure_current = structure
else:
AtomisticGenericJob.structure.fset(self, structure)
def species_from_hdf(self):
if (
"output" in self.project_hdf5.list_groups()
and "interactive" in self.project_hdf5["output"].list_groups()
and "species" in self.project_hdf5["output/interactive"].list_nodes()
):
with self.project_hdf5.open("output/interactive") as hdf:
self._interactive_species_lst = np.array(hdf["species"])
def run_if_interactive(self):
self.status.running = True
if self.structure is None:
raise ValueError("Input structure not set. Use method set_structure()")
if not self.interactive_is_activated():
self.interactive_initialize_interface()
if self._structure_previous is None:
self._structure_previous = self.structure.copy()
self._update_previous_structure()
if self._structure_current is not None:
if (
len(self._structure_current) != len(self._structure_previous)
and not self._interactive_grand_canonical
):
raise ValueError(
"The number of atoms changed, this is currently not supported!"
)
if not self._interactive_enforce_structure_reset:
functions_to_execute = list(self.interactive_input_functions.values())
for v in functions_to_execute:
v()
else:
self._logger.debug("Generic library: structure changed!")
self.interactive_structure_setter(self._structure_current)
def interactive_index_organizer(self):
index_merge_lst = self._interactive_species_lst.tolist() + list(
self._structure_current.get_species_symbols()
)
el_lst = sorted(set(index_merge_lst), key=index_merge_lst.index)
current_structure_index = [
el_lst.index(el)
for el in self._structure_current.get_chemical_symbols()
]
previous_structure_index = [
el_lst.index(el)
for el in self._structure_previous.get_chemical_symbols()
]
if not np.array_equal(
np.array(current_structure_index),
np.array(previous_structure_index),
):
self._logger.debug("Generic library: indices changed!")
self.interactive_indices_setter(self._structure_current.indices)
def interactive_cell_organizer(self):
if not np.allclose(
self._structure_current.cell,
self._structure_previous.cell,
rtol=1e-15, atol=1e-15,
):
self._logger.debug("Generic library: cell changed!")
try:
self.interactive_cells_setter(self._structure_current.cell)
except NotImplementedError:
del self.interactive_input_functions['cell']
def interactive_positions_organizer(self):
if not np.allclose(
self._structure_current.positions,
self._structure_previous.positions,
rtol=1e-15,
atol=1e-15,
):
self._logger.debug("Generic library: positions changed!")
self.interactive_positions_setter(self._structure_current.positions)
def interactive_magmom_organizer(self):
if all(mm is None for mm in self._structure_current.get_initial_magnetic_moments()):
del self.interactive_input_functions['magnetic_moments']
elif (None in self._structure_previous.get_initial_magnetic_moments()
or not np.allclose(
self._structure_current.get_initial_magnetic_moments(),
self._structure_previous.get_initial_magnetic_moments(),
)
):
self._logger.debug("Generic library: magnetic moments changed!")
try:
self.interactive_spin_constraints_setter(
self._structure_current.get_initial_magnetic_moments()
)
except NotImplementedError:
del self.interactive_input_functions['magnetic_moments']
def interactive_cells_getter(self):
return self.initial_structure.cell
def interactive_collect(self):
del_key_lst = []
for k,v in self.interactive_output_functions.items():
try:
value = v()
if value is not None:
self.interactive_cache[k].append(value)
else:
del_key_lst.append(k)
except NotImplementedError:
del_key_lst.append(k)
for k in del_key_lst:
del self.interactive_output_functions[k]
if (
len(list(self.interactive_cache.keys())) > 0
and len(self.interactive_cache[list(self.interactive_cache.keys())[0]])
% self._interactive_flush_frequency
== 0
):
self.interactive_flush(path="interactive")
if self.server.run_mode.interactive_non_modal:
self._interactive_fetch_completed = True
def interactive_flush(self, path="interactive", include_last_step=False):
"""
Args:
path:
include_last_step:
Returns:
"""
with self.project_hdf5.open("output") as hdf_output:
with hdf_output.open(path) as hdf:
hdf["species"] = self._interactive_species_lst.tolist()
super(GenericInteractive, self).interactive_flush(
path=path, include_last_step=include_last_step
)
def interactive_indices_getter(self):
species_symbols = np.array(
[e.Abbreviation for e in self.current_structure.species]
)
self._interactive_species_lst = self._extend_species_elements(
struct_species=species_symbols, species_array=self._interactive_species_lst
)
index_merge_lst = self._interactive_species_lst.tolist() + list(
self._structure_current.get_species_symbols()
)
el_lst = sorted(set(index_merge_lst), key=index_merge_lst.index)
current_structure_index = np.array(
[el_lst.index(el) for el in self._structure_current.get_chemical_symbols()]
)
return current_structure_index
def interactive_positions_getter(self):
return self.current_structure.positions
def interactive_steps_getter(self):
return len(self.interactive_cache[list(self.interactive_cache.keys())[0]])
def interactive_time_getter(self):
return self.interactive_steps_getter()
def interactive_volume_getter(self):
return self.initial_structure.get_volume()
def _update_previous_structure(self):
"""
Update the previous structure to the last step configuration
Args:
wrap_atoms (bool):
"""
try:
indices = self.output.indices[-1]
positions = self.output.positions[-1]
cell = self.output.cells[-1]
except IndexError:
return
if len(self._interactive_species_lst) == 0:
el_lst = [el.Abbreviation for el in self.structure.species]
else:
el_lst = self._interactive_species_lst.tolist()
self._structure_previous.set_species([self._periodic_table.element(el) for el in el_lst])
self._structure_previous.indices = indices
self._structure_previous.positions = positions
self._structure_previous.cell = cell
@staticmethod
def _extend_species_elements(struct_species, species_array):
if not all(np.isin(struct_species, species_array)):
new_elements_index = np.invert(np.isin(struct_species, species_array))
species_array = np.append(species_array, struct_species[new_elements_index])
return species_array
# Functions which have to be implemented by the fin
def interactive_cells_setter(self, cell):
raise NotImplementedError("interactive_cells_getter() is not implemented!")
def interactive_energy_pot_getter(self):
raise NotImplementedError("interactive_energy_pot_getter() is not implemented!")
def interactive_energy_tot_getter(self):
raise NotImplementedError("interactive_energy_tot_getter() is not implemented!")
def interactive_forces_getter(self):
raise NotImplementedError("interactive_forces_getter() is not implemented!")
def interactive_indices_setter(self, indices):
raise NotImplementedError("interactive_indices_setter() is not implemented!")
def interactive_spins_getter(self):
raise NotImplementedError("interactive_spins_getter() is not implemented!")
def interactive_spin_constraints_getter(self):
raise NotImplementedError(
"interactive_spin_constraints_getter() is not implemented!"
)
def interactive_atom_spin_constraints_getter(self):
raise NotImplementedError(
"interactive_atom_spin_constraints_getter() is not implemented!"
)
def interactive_atom_spins_getter(self):
raise NotImplementedError(
"interactive_atom_spins_getter() is not implemented!"
)
def interactive_magnetic_forces_getter(self):
raise NotImplementedError(
"interactive_magnetic_forces_getter() is not implemented!"
)
def interactive_spin_constraints_setter(self, spins):
raise NotImplementedError(
"iinteractive_spin_constraints_setter() is not implemented!"
)
def interactive_initialize_interface(self):
raise NotImplementedError(
"interactive_initialize_interface() is not implemented!"
)
def interactive_positions_setter(self, positions):
raise NotImplementedError("interactive_positions_setter() is not implemented!")
def interactive_pressures_getter(self):
raise NotImplementedError("interactive_pressures_getter() is not implemented!")
def interactive_stress_getter(self):
raise NotImplementedError("interactive_stress_getter() is not implemented!")
def interactive_structure_setter(self, structure):
raise NotImplementedError("interactive_structure_setter() is not implemented!")
def interactive_computation_time_getter(self):
raise NotImplementedError("interactive_computation_time_getter() is not implemented!")
def interactive_temperatures_getter(self):
raise NotImplementedError(
"interactive_temperatures_getter() is not implemented!"
)
def interactive_unwrapped_positions_getter(self):
raise NotImplementedError(
"interactive_unwrapped_positions_getter() is not implemented!"
)
class GenericInteractiveOutput(GenericOutput):
def __init__(self, job):
super(GenericInteractiveOutput, self).__init__(job=job)
def _key_from_cache(self, key):
"""
Get all entries from the interactive cache for a specific key.
Args:
key (str): name of the key
Returns:
list: list of values stored in the interactive cache
"""
if (
key in self._job.interactive_cache.keys()
and self._job.interactive_is_activated()
and len(self._job.interactive_cache[key]) != 0
):
return self._job.interactive_cache[key]
else:
return []
def _lst_from_cache(self, key):
"""
Args:
key (str): name of the key
Returns:
list:
"""
lst = self._key_from_cache(key)
if len(lst) != 0 and isinstance(lst[-1], list):
return [np.array(out) for out in lst]
else:
return lst
def _key_from_hdf(self, key):
"""
Get all entries from the HDF5 file for a specific key - stored under 'output/interactive/<key>'
Args:
key (str): name of the key
Returns:
"""
return self._job["output/interactive/" + key]
def _key_from_property(self, key, prop):
"""
Args:
key (str): name of the key
prop (function):
Returns:
"""
return_lst = self._key_from_cache(key)
hdf5_output = self._key_from_hdf(key)
if hdf5_output is not None:
return_lst = hdf5_output.tolist() + return_lst
else:
prop_result = prop(self)
if prop_result is not None:
return_lst = prop(self).tolist() + return_lst
return np.array(return_lst)
def _lst_from_property(self, key, prop=None):
"""
Args:
key (str):
prop (function):
Returns:
"""
return_lst = self._lst_from_cache(key)
hdf5_output = self._key_from_hdf(key)
if hdf5_output is not None and len(hdf5_output) != 0:
if isinstance(hdf5_output[-1], list):
return_lst = [np.array(out) for out in hdf5_output] + return_lst
else:
return_lst = hdf5_output.tolist() + return_lst
elif prop is not None:
prop_result = prop(self)
if prop_result is not None:
return_lst = prop_result.tolist() + return_lst
return np.array(return_lst)
@property
def indices(self):
return self._lst_from_property(key="indices", prop=GenericOutput.indices.fget)
@property
def cells(self):
return self._key_from_property(key="cells", prop=GenericOutput.cells.fget)
@property
def energy_pot(self):
return self._key_from_property(
key="energy_pot", prop=GenericOutput.energy_pot.fget
)
@property
def energy_tot(self):
return self._key_from_property(
key="energy_tot", prop=GenericOutput.energy_tot.fget
)
@property
def forces(self):
return self._lst_from_property(key="forces", prop=GenericOutput.forces.fget)
@property
def positions(self):
return self._lst_from_property(
key="positions", prop=GenericOutput.positions.fget
)
@property
def pressures(self):
return self._key_from_property(
key="pressures", prop=GenericOutput.pressures.fget
)
@property
def steps(self):
return self._key_from_property(key="steps", prop=GenericOutput.steps.fget)
@property
def temperature(self):
return self._key_from_property(
key="temperature", prop=GenericOutput.temperature.fget
)
@property
def time(self):
return self._key_from_property(
key="computation_time", prop=GenericOutput.computation_time.fget
)
@property
def unwrapped_positions(self):
return self._lst_from_property(
key="unwrapped_positions", prop=GenericOutput.unwrapped_positions.fget
)
@property
def volume(self):
return self._key_from_property(key="volume", prop=GenericOutput.volume.fget)
def __dir__(self):
return list(
set(
list(self._job.interactive_cache.keys())
+ super(GenericOutput).__dir__()
)
)
class InteractiveInterface(object):
def __init__(self):
self._logger = s.logger
def get_cell(self):
raise NotImplementedError
def set_cell(self, cell):
raise NotImplementedError
def get_temperature(self):
raise NotImplementedError
def set_temperature(self, temperature):
raise NotImplementedError
def get_positions(self):
raise NotImplementedError
def set_positions(self, positions):
raise NotImplementedError
def get_forces(self):
raise NotImplementedError
def set_forces(self, forces):
raise NotImplementedError
def get_energy_tot(self):
raise NotImplementedError
def set_energy_tot(self, energy_tot):
raise NotImplementedError
def get_energy_pot(self):
raise NotImplementedError
def set_energy_pot(self, energy_pot):
raise NotImplementedError
def get_pressure(self):
raise NotImplementedError
def set_pressure(self, pressure):
raise NotImplementedError
def run_interactive(self):
raise NotImplementedError