__init__.py 46.9 KB
Newer Older
1
# -*- coding: utf-8 -*-
2
3
4
5
6
from pathlib import Path

from .version import get_version
__version__ = get_version() 

7
8
9
10
11
import numpy as np
from copy import copy, deepcopy
from inspect import ismethod
import os, sys, subprocess

12
13
14
_RESOURCE_DIR = Path(__file__).parent / 'resources'
def get_resource_path(relative_path):
    return _RESOURCE_DIR / relative_path
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

## Abstract classes
class Transformable():
    def __init__(self, position, orientation=None):
        self.position = np.array(position)
        if orientation is not None:
            orientation = np.array(orientation)
        self.orientation = orientation

    def transform(self, R = ((1,0,0),(0,1,0),(0,0,1)),
                  center = (0,0,0), offset = (0,0,0)):

        R,center,offset = [np.array(x) for x in (R,center,offset)]

        self.position = R.dot(self.position-center)+center+offset
                
        if self.orientation is not None:
            ## TODO: what if self.orientation is taken from parent?!
            self.orientation = self.orientation.dot(R)
        ...        

    def collapsedPosition(self):
        # print("collapsedPosition called", type(self), self.name)
        if isinstance(self, Child):
            # print(self.parent, isinstance(self.parent,Transformable))
            if isinstance(self.parent, Transformable):
                return self.applyOrientation(self.position) + self.parent.collapsedPosition()
            
                # if self.parent.orientation is not None:
                #     return self.parent.collapsedOrientation().dot(self.position) + self.parent.collapsedPosition()
        return np.array(self.position) # return a copy
                
    def applyOrientation(self,obj):
        # print("applyOrientation called", self.name, obj)
        if isinstance(self, Child):
            # print( self.orientation, self.orientation is not None, None is not None )
            # if self.orientation is not None:
            #     # print("applyOrientation applying", self, self.name, self.orientation)
            #     obj = self.orientation.dot(obj)
            if isinstance(self.parent, Transformable):
                if self.parent.orientation is not None:
                    obj = self.parent.orientation.dot(obj)
                obj = self.parent.applyOrientation(obj)
        # print("applyOrientation returning", self.name, obj)
        return obj

class Parent():
cmaffeo2's avatar
cmaffeo2 committed
62
    def __init__(self, children=None, remove_duplicate_bonded_terms=False):
63
        self.children = []
cmaffeo2's avatar
cmaffeo2 committed
64
65
66
        if children is not None:
            for x in children:
                self.add(x)
67
68
        
        self.remove_duplicate_bonded_terms = remove_duplicate_bonded_terms
69
70
71
        self.bonds = []
        self.angles = []
        self.dihedrals = []
cmaffeo2's avatar
cmaffeo2 committed
72
        self.impropers = []
73
74
        self.exclusions = []

75
        self.rigid = False
76

77
        ## TODO: self.cacheInvalid = True # What will be in the cache?
78
79
80
81
82
83
84
85
86
87
88

    def add(self,x):
        ## TODO: check the parent-child tree to make sure there are no cycles
        if not isinstance(x,Child):
            raise Exception('Attempted to add an object to a group that does not inherit from the "Child" type')

        if x.parent is not None and x.parent is not self:
            raise Exception("Child {} already belongs to some group".format(x))
        x.parent = self
        self.children.append(x)

89
90
91
92
93
94
95
96
97
98
99
100
101
    def insert(self,idx,x):
        ## TODO: check the parent-child tree to make sure there are no cycles
        if not isinstance(x,Child):
            raise Exception('Attempted to add an object to a group that does not inherit from the "Child" type')

        if x.parent is not None and x.parent is not self:
            raise Exception("Child {} already belongs to some group".format(x))
        x.parent = self
        self.children.insert(idx,x)

    def index(self, x):
        return self.children.index(x)

102
103
104
105
106
107
108
109
    def clear_all(self, keep_children=False):
        if keep_children == False:
            for x in self.children:
                x.parent = None
            self.children = []
        self.bonds = []
        self.angles = []
        self.dihedrals = []
cmaffeo2's avatar
cmaffeo2 committed
110
        self.impropers = []
111
112
        self.exclusions = []

113
114
115
    def remove(self,x):
        if x in self.children:
            self.children.remove(x)
116
117
            if x.parent is self:
                x.parent = None
118
119
120

    def add_bond(self, i,j, bond, exclude=False):
        ## TODO: how to handle duplicating and cloning bonds
121
122
        # beads = [b for b in self]
        # for b in (i,j): assert(b in beads)
123
124
125
        self.bonds.append( (i,j, bond, exclude) )

    def add_angle(self, i,j,k, angle):
126
127
        # beads = [b for b in self]
        # for b in (i,j,k): assert(b in beads)
128
129
130
        self.angles.append( (i,j,k, angle) )

    def add_dihedral(self, i,j,k,l, dihedral):
131
132
        # beads = [b for b in self]
        # for b in (i,j,k,l): assert(b in beads)
133
134
        self.dihedrals.append( (i,j,k,l, dihedral) )

cmaffeo2's avatar
cmaffeo2 committed
135
    def add_improper(self, i,j,k,l, dihedral):
136
137
        # beads = [b for b in self]
        # for b in (i,j,k,l): assert(b in beads)
cmaffeo2's avatar
cmaffeo2 committed
138
139
        self.impropers.append( (i,j,k,l, dihedral) )

140
141
    def add_exclusion(self, i,j):
        ## TODO: how to handle duplicating and cloning bonds
142
143
144
        ## TODO: perform following check elsewhere
        # beads = [b for b in self]
        # for b in (i,j): assert(b in beads)
145
146
        self.exclusions.append( (i,j) )

147
148
149
150
151
152
    def get_restraints(self):
        ret = []
        for c in self.children:
            ret.extend( c.get_restraints() )
        return ret

153
154
155
156
    def get_bonds(self):
        ret = self.bonds
        for c in self.children:
            if isinstance(c,Parent): ret.extend( c.get_bonds() )
157
158
159
160
161
        if self.remove_duplicate_bonded_terms:
            return list(set(ret))
        else:
            return ret

162
163
164
165
166

    def get_angles(self):
        ret = self.angles
        for c in self.children:
            if isinstance(c,Parent): ret.extend( c.get_angles() )
167
168
169
170
        if self.remove_duplicate_bonded_terms:
            return list(set(ret))
        else:
            return ret
171
172
173
174
175

    def get_dihedrals(self):
        ret = self.dihedrals
        for c in self.children:
            if isinstance(c,Parent): ret.extend( c.get_dihedrals() )
176
177
178
179
        if self.remove_duplicate_bonded_terms:
            return list(set(ret))
        else:
            return ret
180

cmaffeo2's avatar
cmaffeo2 committed
181
182
183
184
    def get_impropers(self):
        ret = self.impropers
        for c in self.children:
            if isinstance(c,Parent): ret.extend( c.get_impropers() )
185
186
187
188
        if self.remove_duplicate_bonded_terms:
            return list(set(ret))
        else:
            return ret
cmaffeo2's avatar
cmaffeo2 committed
189

190
191
192
193
    def get_exclusions(self):
        ret = self.exclusions
        for c in self.children:
            if isinstance(c,Parent): ret.extend( c.get_exclusions() )
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
        if self.remove_duplicate_bonded_terms:
            return list(set(ret))
        else:
            return ret

    ## Removed because prohibitively slow
    # def remove_duplicate_terms(self):
    #     for key in "bonds angles dihedrals impropers exclusions".split():
    #         self.remove_duplicate_item(key)

    # def remove_duplicate_item(self, dict_key, existing=None):
    #     if existing is None: existing = []
    #     ret = [i for i in list(set(self.__dict__[dict_key])) if i not in existing]
    #     self.__dict__[dict_key] = ret
    #     existing.extend(ret)
    #     for c in self.children:
    #         if isinstance(c,Parent): 
    #             ret = ret + c.remove_duplicate_item(dict_key, existing)
    #     return ret
        
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

    def __iter__(self):
        ## TODO: decide if this is the nicest way to do it!
        """Depth-first iteration through tree"""
        for x in self.children:
            if isinstance(x,Parent):
                if isinstance(x,Clone) and not isinstance(x.get_original_recursively(),Parent):
                    yield x
                else:
                    for y in x:
                        yield y
            else:
                yield x    

    def __len__(self):
        l = 0
        for x in self.children:
            if isinstance(x,Parent):
                l += len(x)
            else:
                l += 1
        return l
        
    def __getitem__(self, i):
        return self.children[i]
    
    def __setitem__(self, i, val):
        x = self.children[i]
        x.parent = None
        val.parent = self
        self.children[i] = val
        
class Child():
    def __init__(self, parent=None):
        self.parent = parent
249
250
251
        if parent is not None:
            assert( isinstance(parent, Parent) )
            parent.children.append(self)
252
253
254
255

    def __getattr__(self, name):
        """
        Try to get attribute from the parent
256

257
258
        """
        # if self.parent is not None:
259
        if "parent" not in self.__dict__ or self.__dict__["parent"] is None or name is "children":
260
            raise AttributeError("'{}' object has no attribute '{}'".format(type(self).__name__, name))
cmaffeo2's avatar
cmaffeo2 committed
261

262
263
264
265
266

        excluded_attributes = ['parent','rigid']
        if name in excluded_attributes:
            raise AttributeError("'{}' object has no attribute '{}' and cannot look it up from the parent".format(type(self).__name__, name))

cmaffeo2's avatar
cmaffeo2 committed
267
268
269
270
271
272
273
274
275
        ## TODO: determine if there is a way to avoid __getattr__ if a method is being looked up  
        try:
            ret = getattr(self.parent,name)
        except:
            raise AttributeError("'{}' object has no attribute '{}'".format(type(self).__name__, name))
        if ismethod(ret):
            raise AttributeError("'{}' object has no method '{}'".format(type(self).__name__, name))
        return ret 

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
            
    # def __getstate__(self):
    #     print("Child getstate called", self)
    #     print(self.__dict__)
    #     return (self.__dict__,)

    # def __setstate__(self, state):
    #     self.__dict__, = state

class Clone(Transformable, Parent, Child):
    def __init__(self, original, parent=None,
                 position = None,
                 orientation = None):
        if position is None and original.position is not None:
            position = np.array( original.position )
        if orientation is None and original.orientation is not None:
            orientation = np.array( original.orientation )
        if parent is None:
            parent = original.parent
        self.original = original
        Child.__init__(self, parent)        
        Transformable.__init__(self, position, orientation)        

        ## TODO: keep own bond_list, etc, update when needed original changes

        if "children" in original.__dict__ and len(original.children) > 0:
            self.children = [Clone(c, parent = self) for c in original.children]
        else:
            self.children = []

    def get_original_recursively(self):
        if isinstance(self.original, Clone):
            return self.original.get_original_recursively()
        else:
            return self.original

    def __getattr__(self, name):
        """
        Try to get attribute from the original without descending the tree heirarchy, then look up parent

        TODO: handle PointParticle lookups into ParticleType
        """
        # print("Clone getattr",name)
        if name in self.original.__dict__:
            return self.original.__dict__[name]
        else:
            if "parent" not in self.__dict__ or self.__dict__["parent"] is None:
                raise AttributeError("'{}' object has no attribute '{}'".format(type(self).__name__, name))
            return getattr(self.parent, name)
        

## Particle classes
class ParticleType():
    """Class that hold common attributes that particles can point to"""

    excludedAttributes = ("idx","type_",
                          "position",
333
                          "children",
334
                          "parent", "excludedAttributes","rigid"
335
336
    )

337
338
    def __init__(self, name, charge=0, parent=None, **kargs):
        """ Parent type is used to fall back on for nonbonded interactions if this type is not specifically referenced """
339
340
341

        self.name        = name
        self.charge = charge
342
343
        self.parent = parent

344
345
346
347
348
349
        for key in ParticleType.excludedAttributes:
            assert( key not in kargs )

        for key,val in kargs.items():
            self.__dict__[key] = val

350
351
352
353
354
355
356
357
358
    def is_same_type(self, other):
        assert(isinstance(other,ParticleType))
        if self == other:
            return True
        elif self.parent is not None and self.parent == other:
            return True
        else:
            return False

359
360
361
    def __hash_key(self):
        l = [self.name,self.charge]
        for keyval in sorted(self.__dict__.items()):
362
            if isinstance(keyval[1], list): keyval = (keyval[0],tuple(keyval[1]))
363
364
365
366
367
368
369
370
371
            l.extend(keyval)
        return tuple(l)

    def __hash__(self):
        return hash(self.__hash_key())
    
    def _equal_check(a,b):
        if a.name == b.name:
            if a.__hash_key() != b.__hash_key():
372
                raise Exception("Two different ParticleTypes have same 'name' attribute")
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388

    def __eq__(a,b):
        a._equal_check(b)
        return a.name == b.name
    def __lt__(a,b):
        a._equal_check(b)
        return a.name < b.name
    def __le__(a,b):
        a._equal_check(b)
        return a.name <= b.name
    def __gt__(a,b):
        a._equal_check(b)
        return a.name > b.name
    def __ge__(a,b):
        a._equal_check(b)
        return a.name >= b.name
389
390
391
392

    def __repr__(self):
        return '<{} {}{}>'.format( type(self), self.name, '[{}]'.format(self.parent) if self.parent is not None else '' )

393
394

class PointParticle(Transformable, Child):
395
    def __init__(self, type_, position, name="A", **kwargs):
396
397
398
399
        parent = None
        if 'parent' in kwargs:
            parent = kwargs['parent']
        Child.__init__(self, parent=parent)
400
401
402
403
404
405
        Transformable.__init__(self,position)

        self.type_    = type_                
        self.idx     = None
        self.name = name
        self.counter = 0
406
        self.restraints = []
407
408
409
410

        for key,val in kwargs.items():
            self.__dict__[key] = val
        
411
412
413
414
415
416
417
    def add_restraint(self, restraint):
        ## TODO: how to handle duplicating and cloning bonds
        self.restraints.append( restraint )

    def get_restraints(self):
        return [(self,r) for r in self.restraints]

418
419
420
    def duplicate(self):
        new = deepcopy(self)
        return new
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437

    def __getattr__(self, name):
        """
        First try to get attribute from the parent, then type_
        
        Note that this data structure seems to be fragile, can result in stack overflow
        
        """
        # return Child.__getattr__(self,name)
        try:
            return Child.__getattr__(self,name)
        except Exception as e:
            if 'type_' in self.__dict__:
                return getattr(self.type_, name)
            else:
                raise AttributeError("'{}' object has no attribute '{}'".format(type(self).__name__, name))

cmaffeo2's avatar
cmaffeo2 committed
438
439
440
441
442
443
    def _get_psfpdb_dictionary(self):
        p = self
        try:
            segname = p.segname
        except:
            segname = "A"
444
445
446
447
        try:
            chain = p.chain
        except:
            chain = "A"
cmaffeo2's avatar
cmaffeo2 committed
448
449
450
451
452
453
454
455
        try:
            resname = p.resname
        except:
            resname = p.name[:3]
        try:
            resid = p.resid
        except:
            resid = p.idx+1
456
457
458
459
        try:
            mass = p.mass
        except:
            mass = 1
cmaffeo2's avatar
cmaffeo2 committed
460
461
462
463
464
465
466
467
468
469
470
471
472

        try:
            occ = p.occupancy
        except:
            occ = 0
        try:
            beta = p.beta
        except:
            beta = 0

        data = dict(segname = segname,
                    resname = resname,
                    name = str(p.name)[:4],
473
                    chain = chain[0],
cmaffeo2's avatar
cmaffeo2 committed
474
475
                    resid = int(resid),
                    idx = p.idx+1,
476
                    type = p.type_.name[:7],
cmaffeo2's avatar
cmaffeo2 committed
477
                    charge = p.charge,
478
                    mass = mass,
cmaffeo2's avatar
cmaffeo2 committed
479
480
481
482
483
                    occupancy = occ,
                    beta = beta
                )
        return data

484
485

class Group(Transformable, Parent, Child):
cmaffeo2's avatar
cmaffeo2 committed
486

cmaffeo2's avatar
cmaffeo2 committed
487
    def __init__(self, name=None, children = None, parent=None, 
488
489
                 position = np.array((0,0,0)),
                 orientation = np.array(((1,0,0),(0,1,0),(0,0,1))),
490
                 remove_duplicate_bonded_terms = False,
cmaffeo2's avatar
cmaffeo2 committed
491
492
                 **kwargs):

493
494
        Transformable.__init__(self, position, orientation)
        Child.__init__(self, parent) # Initialize Child first
495
        Parent.__init__(self, children, remove_duplicate_bonded_terms)
496
497
498
        self.name = name
        self.isClone = False

cmaffeo2's avatar
cmaffeo2 committed
499
500
501
502
        for key,val in kwargs.items():
            self.__dict__[key] = val


503
504
505
506
507
508
509
510
511
512
513
514
515
    def clone(self):
        return Clone(self)
        g = copy(self)
        g.isClone = True        # TODO: use?
        g.children = [copy(c) for c in g.children]
        for c in g.children:
            c.parent = g
        return g
        g = Group(position = self.position,
                  orientation = self.orientation)
        g.children = self.children # lists point to the same object

    def duplicate(self):
cmaffeo2's avatar
cmaffeo2 committed
516
517
518
519
        new = deepcopy(self)
        for c in new.children:
            c.parent = new
        return new
520
521
522
523
        # Group(position = self.position,
        #       orientation = self.orientation)
        # g.children = deepcopy self.children.deepcopy() # lists are the same object

524
    ## TODO override deepcopy so parent can be excluded from copying?
525
526
527
528
529
530
531
532
533
534
        
    # def __getstate__(self):
    #     return (self.children, self.parent, self.position, self.orientation)

    # def __setstate__(self, state):
    #     self.children, self.parent, self.position, self.orientation = state

        
class PdbModel(Transformable, Parent):

cmaffeo2's avatar
cmaffeo2 committed
535
    def __init__(self, children=None, dimensions=None, remove_duplicate_bonded_terms=False):
536
        Transformable.__init__(self,(0,0,0))
537
        Parent.__init__(self, children, remove_duplicate_bonded_terms)
538
539
540
541
542
543
544
        self.dimensions = dimensions
        self.particles = [p for p in self]
        self.cacheInvalid = True

    def _updateParticleOrder(self):
        pass

545
    def writePdb(self, filename, beta_from_fixed=False):
546
547
548
549
        if self.cacheInvalid:
            self._updateParticleOrder()
        with open(filename,'w') as fh:
            ## Write header
550
            fh.write("CRYST1{:>9.3f}{:>9.3f}{:>9.3f}  90.00  90.00  90.00 P 1           1\n".format( *self.dimensions ))
551
552

            ## Write coordinates
cmaffeo2's avatar
cmaffeo2 committed
553
            formatString = "ATOM {idx:>6.6s} {name:^4.4s} {resname:3.3s} {chain:1.1s}{resid:>5.5s}   {x:8.8s}{y:8.8s}{z:8.8s}{occupancy:6.2f}{beta:6.2f}  {charge:2d}{segname:>6s}\n"
554
555
            for p in self.particles:
                ## http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
cmaffeo2's avatar
cmaffeo2 committed
556
557
558
                data = p._get_psfpdb_dictionary()
                idx = data['idx']

559
                if np.log10(idx) >= 5:
560
                    idx = " *****"
561
562
                else:
                    idx = "{:>6d}".format(idx)
cmaffeo2's avatar
cmaffeo2 committed
563
                data['idx'] = idx
564

565
566
567
                if beta_from_fixed:
                    data['beta'] = 1 if 'fixed' in p.__dict__ else 0

568
                pos = p.collapsedPosition()
569
                dig = [max(int(np.log10(np.abs(x)+1e-6)//1),0)+1 for x in pos]
570
571
572
573
                for d in dig: assert( d <= 7 )
                # assert( np.all(dig <= 7) )
                fs = ["{: %d.%df}" % (8,7-d) for d in dig]
                x,y,z = [f.format(x) for f,x in zip(fs,pos)] 
cmaffeo2's avatar
cmaffeo2 committed
574
575
576
577
578
579
580
                data['x'] = x
                data['y'] = y
                data['z'] = z
                assert(data['resid'] < 1e5)
                data['charge'] = int(data['charge'])
                data['resid'] = "{:<4d}".format(data['resid'])
                fh.write( formatString.format(**data) )
581

582
583
584
585
586
587
588
589
        return
        
    def writePsf(self, filename):
        if self.cacheUpToDate == False:
            self._updateParticleOrder()
        with open(filename,'w') as fh:
            ## Write header
            fh.write("PSF NAMD\n\n") # create NAMD formatted psf
cmaffeo2's avatar
cmaffeo2 committed
590
            fh.write("{:>8d} !NTITLE\n\n".format(0))
591
592
593
594
595
596
            
            ## ATOMS section
            fh.write("{:>8d} !NATOM\n".format(len(self.particles)))

            ## From vmd/plugins/molfile_plugin/src/psfplugin.c
            ## "%d %7s %10s %7s %7s %7s %f %f"
cmaffeo2's avatar
cmaffeo2 committed
597
598
            formatString = "{idx:>8d} {segname:7.7s} {resid:<10.10s} {resname:7.7s}" + \
                           " {name:7.7s} {type:7.7s} {charge:f} {mass:f}\n"
599
            for p in self.particles:
cmaffeo2's avatar
cmaffeo2 committed
600
601
602
                data = p._get_psfpdb_dictionary()
                data['resid'] = "%d%c%c" % (data['resid']," "," ") # TODO: work with large indices
                fh.write( formatString.format(**data) )
603
604
605
606
607
608
609
            fh.write("\n")

            ## Write out bonds
            bonds = self.get_bonds()
            fh.write("{:>8d} !NBOND\n".format(len(bonds)))
            counter = 0
            for p1,p2,b,ex in bonds:
610
                fh.write( "{:>8d}{:>8d}".format(p1.idx+1,p2.idx+1) )
611
                counter += 1
612
                if counter == 4:
613
614
                    fh.write("\n")
                    counter = 0
cmaffeo2's avatar
cmaffeo2 committed
615
616
                else:
                    fh.write(" ")
617
            fh.write("\n" if counter == 0 else "\n\n")
618

cmaffeo2's avatar
cmaffeo2 committed
619
620
621
622
623
            ## Write out angles
            angles = self.get_angles()
            fh.write("{:>8d} !NTHETA\n".format(len(angles)))
            counter = 0
            for p1,p2,p3,a in angles:
624
                fh.write( "{:>8d}{:>8d}{:>8d}".format(p1.idx+1,p2.idx+1,p3.idx+1) )
cmaffeo2's avatar
cmaffeo2 committed
625
                counter += 1
626
                if counter == 3:
cmaffeo2's avatar
cmaffeo2 committed
627
628
                    fh.write("\n")
                    counter = 0
cmaffeo2's avatar
cmaffeo2 committed
629
630
                else:
                    fh.write(" ")
631
            fh.write("\n" if counter == 0 else "\n\n")
cmaffeo2's avatar
cmaffeo2 committed
632
633
634
635
636
637

            ## Write out dihedrals
            dihedrals = self.get_dihedrals()
            fh.write("{:>8d} !NPHI\n".format(len(dihedrals)))
            counter = 0
            for p1,p2,p3,p4,a in dihedrals:
638
                fh.write( "{:>8d}{:>8d}{:>8d}{:>8d}".format(p1.idx+1,p2.idx+1,p3.idx+1,p4.idx+1) )
cmaffeo2's avatar
cmaffeo2 committed
639
640
641
642
                counter += 1
                if counter == 2:
                    fh.write("\n")
                    counter = 0
cmaffeo2's avatar
cmaffeo2 committed
643
                else:
644
645
                    fh.write(" ") 
            fh.write("\n" if counter == 0 else "\n\n")
cmaffeo2's avatar
cmaffeo2 committed
646
647
648
649
650
651

            ## Write out impropers
            impropers = self.get_impropers()
            fh.write("{:>8d} !NIMPHI\n".format(len(impropers)))
            counter = 0
            for p1,p2,p3,p4,a in impropers:
652
                fh.write( "{:>8d}{:>8d}{:>8d}{:>8d}".format(p1.idx+1,p2.idx+1,p3.idx+1,p4.idx+1) )
cmaffeo2's avatar
cmaffeo2 committed
653
654
655
656
                counter += 1
                if counter == 2:
                    fh.write("\n")
                    counter = 0
cmaffeo2's avatar
cmaffeo2 committed
657
658
                else:
                    fh.write(" ")
659
660
661
662
663
664
665
666
667
668
669
            fh.write("\n" if counter == 0 else "\n\n")

            fh.write("\n{:>8d} !NDON: donors\n\n\n".format(0))
            fh.write("\n{:>8d} !NACC: acceptors\n\n\n".format(0))
            fh.write("\n       0 !NNB\n\n")
            natoms = len(self.particles)
            for i in range(natoms//8):
                fh.write("      0       0       0       0       0       0       0       0\n")
            for i in range(natoms-8*(natoms//8)):
                fh.write("      0")
            fh.write("\n\n       1       0 !NGRP\n\n")
670
671
672


class ArbdModel(PdbModel):
673
674
675
676
677
    def __init__(self, children, dimensions=(1000,1000,1000), temperature=291, timestep=50e-6,
                 particle_integrator = 'Brown',
                 cutoff=50, decompPeriod=1000, pairlistDistance=None, nonbondedResolution=0.1,
                 remove_duplicate_bonded_terms=True):

678
        PdbModel.__init__(self, children, dimensions, remove_duplicate_bonded_terms)
679
680
681
682
683
        self.temperature = temperature

        self.timestep = timestep
        self.cutoff  =  cutoff

684
685
        self.particle_integrator = particle_integrator
        
686
        if pairlistDistance == None:
687
            pairlistDistance = cutoff+30
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
        
        self.decompPeriod = decompPeriod
        self.pairlistDistance = pairlistDistance

        self.numParticles = 0
        self.particles = []
        self.type_counts = None

        self.nbSchemes = []
        self._nbParamFiles = [] # This could be made more robust
        self.nbResolution = 0.1

        self._written_bond_files = dict()        

        self.cacheUpToDate = False

704
705
706
707
708
709
710
    def clear_all(self, keep_children=False):
        Parent.clear_all(self, keep_children=keep_children)
        self.particles = []
        self.numParticles = 0
        self.type_counts = None
        self._nbParamFiles = []
        self._written_bond_files = dict()
711
712
713
714
715
716
717

    def _getNbScheme(self, typeA, typeB):
        scheme = None
        for s,A,B in self.nbSchemes:
            if A is None or B is None:
                if A is None and B is None:
                    return s
718
                elif A is None and typeB.is_same_type(B):
719
                    return s
720
                elif B is None and typeA.is_same_type(A):
721
                    return s
722
            elif typeA.is_same_type(A) and typeB.is_same_type(B):
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
                return s
        raise Exception("No nonbonded scheme found for %s and %s" % (typeA.name, typeB.name))

    def _countParticleTypes(self):
        ## TODO: check for modifications to particle that require
        ## automatic generation of new particle type
        type_counts = dict()
        for p in self:
            t = p.type_
            if t in type_counts:
                type_counts[t] += 1
            else:
                type_counts[t] = 1
        self.type_counts = type_counts

    def _updateParticleOrder(self):
        ## Create ordered list
740
741
        self.particles = [p for p in self]
        # self.particles = sorted(particles, key=lambda p: (p.type_, p.idx))
742
743
744
745
746
747
748
749
750
751
752
753
        
        ## Update particle indices
        for p,i in zip(self.particles,range(len(self.particles))):
            p.idx = i
            
        # self.initialCoords = np.array([p.initialPosition for p in self.particles])

    def useNonbondedScheme(self, nbScheme, typeA=None, typeB=None):
        self.nbSchemes.append( (nbScheme, typeA, typeB) )
        if typeA != typeB:
            self.nbSchemes.append( (nbScheme, typeB, typeA) )

754
    def simulate(self, output_name, output_directory='output', num_steps=100000000, timestep=None, gpu=0, output_period=1e4, arbd=None, directory='.', restart_file=None, replicas=1, dry_run = False):
755
        assert(type(gpu) is int)
756
        num_steps = int(num_steps)
757

758
759
760
761
762
        d_orig = os.getcwd()
        try:
            if not os.path.exists(directory):
                os.makedirs(directory)
            os.chdir(directory)
New Tbgl User's avatar
New Tbgl User committed
763

764
765
            if timestep is not None:
                self.timestep = timestep
766

767
768
769
770
            if self.cacheUpToDate == False: # TODO: remove cache?
                self._countParticleTypes()
                self._updateParticleOrder()

771
            if output_directory == '': output_directory='.'
772

773
774
775
776
777
778
779
780
781
782
783
784
            if dry_run:
                if arbd is None: arbd='arbd'
            else:
                if arbd is None:
                    for path in os.environ["PATH"].split(os.pathsep):
                        path = path.strip('"')
                        fname = os.path.join(path, "arbd")
                        if os.path.isfile(fname) and os.access(fname, os.X_OK):
                            arbd = fname
                            break

                if arbd is None: raise Exception("ARBD was not found")
785

786
787
788
789
790
791
                if not os.path.exists(arbd):
                    raise Exception("ARBD was not found")
                if not os.path.isfile(arbd):
                    raise Exception("ARBD was not found")
                if not os.access(arbd, os.X_OK):
                    raise Exception("ARBD is not executable")
792
793


794
795
796
797
            if not os.path.exists(output_directory):
                os.makedirs(output_directory)
            elif not os.path.isdir(output_directory):
                raise Exception("output_directory '%s' is not a directory!" % output_directory)
798
799


800
801
            self.writePdb( output_name + ".pdb" )
            self.writePsf( output_name + ".psf" )
802
            self.writeArbdFiles( output_name, numSteps=num_steps, outputPeriod=output_period, restart_file=restart_file )
803
804
805
            os.sync()

            ## http://stackoverflow.com/questions/18421757/live-output-from-subprocess-command
cmaffeo2's avatar
cmaffeo2 committed
806
807
808
809
810

            cmd = [arbd, '-g', "%d" % gpu]
            if replicas > 1:
                cmd = cmd + ['-r',replicas]
            cmd = cmd + ["%s.bd" % output_name, "%s/%s" % (output_directory, output_name)]
811
812
            cmd = tuple(str(x) for x in cmd)

813
814
815
816
817
818
819
820
            if dry_run:
                print("Run with: %s" % " ".join(cmd))
            else:
                print("Running ARBD with: %s" % " ".join(cmd))
                process = subprocess.Popen(cmd, stdout=subprocess.PIPE, universal_newlines=True)
                for line in process.stdout:
                    sys.stdout.write(line)
                    sys.stdout.flush()
821
822
823
824
825

        except:
            raise
        finally:
            os.chdir(d_orig)
826
827
828
829
830
831


    # -------------------------- #
    # Methods for printing model #
    # -------------------------- #

832
    def writeArbdFiles(self, prefix, numSteps=100000000, outputPeriod=10000, restart_file=None):
833
        ## TODO: save and reference directories and prefixes using member data
834
        d = self.potential_directory = "potentials"
835
836
        if not os.path.exists(d):
            os.makedirs(d)
837
        self._restraint_filename = "%s/%s.restraint.txt" % (d, prefix)
838
839
840
841
842
        self._bond_filename = "%s/%s.bonds.txt" % (d, prefix)
        self._angle_filename = "%s/%s.angles.txt" % (d, prefix)
        self._dihedral_filename = "%s/%s.dihedrals.txt" % (d, prefix)
        self._exclusion_filename = "%s/%s.exculsions.txt" % (d, prefix)
        
843
844
        # self._writeArbdCoordFile( prefix + ".coord.txt" )
        self._writeArbdParticleFile( prefix + ".particles.txt" )
845
        self._writeArbdRestraintFile()
846
847
848
849
850
        self._writeArbdBondFile()
        self._writeArbdAngleFile()
        self._writeArbdDihedralFile()
        self._writeArbdExclusionFile()
        self._writeArbdPotentialFiles( prefix, directory = d )
851
        self._writeArbdConf( prefix, numSteps=numSteps, outputPeriod=outputPeriod, restart_file=restart_file )
852
        
853
854
855
856
857
858
    # def _writeArbdCoordFile(self, filename):
    #     with open(filename,'w') as fh:
    #         for p in self.particles:
    #             fh.write("%f %f %f\n" % tuple(x for x in p.collapsedPosition()))

    def _writeArbdParticleFile(self, filename):
859
        with open(filename,'w') as fh:
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
            if self.particle_integrator == "Brown":
                for p in self.particles:
                    data = tuple([p.idx,p.type_.name] + [x for x in p.collapsedPosition()])
                    fh.write("ATOM %d %s %f %f %f\n" % data)
            else:
                for p in self.particles:
                    data = [p.idx,p.type_.name] + [x for x in p.collapsedPosition()]
                    try:
                        data = data + p.momentum
                    except:
                        try:
                            data = data + p.velocity*p.mass
                        except:
                            data = data + [0,0,0]
                    fh.write("ATOM %d %s %f %f %f %f %f %f\n" % tuple(data))
                
    def _write_rigid_group_file(self, filename, groups):
        with open(filename,'w') as fh:
            for g in groups:
                fh.write("#Group\n")
                try:
                    if len(g.trans_damping) != 3: raise
                    fh.write(" ".join(str(v) for v in g.trans_damping) + " ")
                except:
                    raise ValueError("Group {} lacks 3-value 'trans_damping' attribute")
                try:
                    if len(g.rot_damping) != 3: raise
                    fh.write(" ".join(str(v) for v in g.rot_damping) + " ")
                except:
                    raise ValueError("Group {} lacks 3-value 'rot_damping' attribute")
                fh.write("{}\n".format(len(g)))
                particles = [p for p in g]

                def chunks(l, n):
                    """Yield successive n-sized chunks from l."""
                    for i in range(0, len(l), n):
                        yield l[i:i + n]

                for c in chunks(particles,8):
                    fh.write(" ".join(str(p.idx) for p in c) + "\n")


    def _writeArbdConf(self, prefix, randomSeed=None, numSteps=100000000, outputPeriod=10000, restart_file=None):
903
904
905
906
907
908
909
910
911
912
913
914
        ## TODO: raise exception if _writeArbdPotentialFiles has not been called
        filename = "%s.bd" % prefix

        ## Prepare a dictionary to fill in placeholders in the configuration file
        params = self.__dict__.copy() # get parameters from System object

        if randomSeed is None:
            params['randomSeed']     = ""
        else:
            params['randomSeed'] = "seed %s" % randomSeed
        params['numSteps']       = int(numSteps)

915
916
        # params['coordinateFile'] = "%s.coord.txt" % prefix
        params['particleFile'] = "%s.particles.txt" % prefix
917
        if restart_file is None:
918
919
            params['restartCoordinates'] = ""
        else:
920
            params['restartCoordinates'] = "restartCoordinates %s" % restart_file
921
922
923
924
925
        params['outputPeriod'] = outputPeriod

        for k,v in zip('XYZ', self.dimensions):
            params['origin'+k] = -v*0.5
            params['dim'+k] = v
cmaffeo2's avatar
cmaffeo2 committed
926
927
        
        params['pairlistDistance'] -= params['cutoff'] 
928

929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
        """ Find rigid groups """
        rigid_groups = []
        def get_rigid_groups(parent):
            ret_list = []
            for c in parent.children:
                is_rigid = c.rigid if 'rigid' in c.__dict__ else False
                if is_rigid:
                    rigid_groups.append(c)
                elif isinstance(c,Group):
                    get_rigid_groups(c)
        get_rigid_groups(self)

        if len(rigid_groups) > 0:
            self.particle_integrator = 'FusDynamic'
            rb_group_filename = "{}.rb-group.txt".format(prefix)
            params['particle_integrator'] = """FusDynamics
groupFileName {}
scaleFactor 0.05""".format(rb_group_filename)
            self._write_rigid_group_file(rb_group_filename, rigid_groups)

949
950
951
952
953
954
955
956
957
958
        ## Actually write the file
        with open(filename,'w') as fh:
            fh.write("""{randomSeed}
timestep {timestep}
steps {numSteps}
numberFluct 0                   # deprecated

interparticleForce 1            # other values deprecated
fullLongRange 0                 # deprecated
temperature {temperature}
959
ParticleDynamicType {particle_integrator}
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976

outputPeriod {outputPeriod}
## Energy doesn't actually get printed!
outputEnergyPeriod {outputPeriod}
outputFormat dcd

## Infrequent domain decomposition because this kernel is still very slow
decompPeriod {decompPeriod}
cutoff {cutoff}
pairlistDistance {pairlistDistance}

origin {originX} {originY} {originZ}
systemSize {dimX} {dimY} {dimZ}
\n""".format(**params))
            
            ## Write entries for each type of particle
            for pt,num in self.getParticleTypesAndCounts():
cmaffeo2's avatar
cmaffeo2 committed
977
                ## TODO create new particle types if existing has grid
978
979
                particleParams = pt.__dict__.copy()
                particleParams['num'] = num
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
                if self.particle_integrator in ('Brown','Brownian'):
                    try:
                        D = pt.diffusivity
                    except:
                        """ units "k K/(amu/ns)" "AA**2/ns" """
                        D = 831447.2 * self.temperature / (pt.mass * pt.damping_coefficient)
                    particleParams['dynamics'] = 'diffusion {D}'.format(D = D)
                elif self.particle_integrator in ('Langevin','FusDynamic'):
                    try:
                        gamma = pt.damping_coefficient
                    except:
                        """ units "k K/(AA**2/ns)" "amu/ns" """
                        gamma = 831447.2 * self.temperature / (pt.mass*pt.diffusivity)
                    particleParams['dynamics'] = """mass {mass}
transDamping {g} {g} {g}
""".format(mass=pt.mass, g=gamma)
                else:
                    raise ValueError("Unrecognized particle integrator '{}'".format(self.particle_integrator))
998
999
1000
                fh.write("""
particle {name}
num {num}
For faster browsing, not all history is shown. View entire blame