finesse.py 23.2 KB
Newer Older
Daniel Brown's avatar
Daniel Brown committed
1
2
3
4
# -*- coding: utf-8 -*-
"""
Created on Sun Jan 27 09:56:53 2013

5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
PyKat - Python interface and wrapper for FINESSE
Copyright (C) 2013 Daniel David Brown

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Contact at ddb@star.sr.bham.ac.uk

@author: Daniel Brown
Daniel Brown's avatar
Daniel Brown committed
25
"""
26
import sys
Daniel Brown's avatar
Daniel Brown committed
27
28
29
30
import os
import subprocess
import tempfile
import numpy as np
31
32
import datetime
import pickle
33
import pykat
34
import warnings
35
import re
Daniel Brown's avatar
Daniel Brown committed
36

37
from pykat.exceptions import *
38

Daniel Brown's avatar
Daniel Brown committed
39
40
41
from pykat.node_network import NodeNetwork
from pykat.detectors import Detector
from pykat.components import Component
42
from pykat.commands import Command, xaxis
Daniel Brown's avatar
Daniel Brown committed
43
44
from pykat.gui.gui import pyKatGUI

45
46
47
from PyQt4.QtCore import QCoreApplication
from PyQt4.QtGui import QApplication

Daniel Brown's avatar
Daniel Brown committed
48
NO_GUI = False
49
50
NO_BLOCK = "NO_BLOCK"

51
class katRun(object):
Daniel Brown's avatar
Daniel Brown committed
52
    def __init__(self):
53
54
55
56
57
58
59
60
        self.runDateTime = datetime.datetime.now()
        self.x = None
        self.y = None
        self.xlabel = None
        self.ylabels = None
        self.katScript = None
        self.katVersion = None
        
61
    def saveKatRun(self, filename):
62
        with open(filename,'w') as outfile:
63
            pickle.dump(self, outfile)
Daniel Brown's avatar
Daniel Brown committed
64
    
65
66
67
68
69
70
    @staticmethod
    def loadKatRun(filename):
        with open(filename,'r') as infile:
            return pickle.load(infile)
        
        
71
72
73
class Block:
    def __init__(self, name):
        self.__name = name
74
        self.contents = [] # List of objects and strings of finesse code
75
76
77
78
79
        self.enabled = True 
        
    @property
    def name(self): return self.__name
    
80
81
class kat(object):                    
        
82
    def __init__(self, kat_file=None, kat_code=None, katdir="", katname="", tempdir=None, tempname=None):
83
        
84
        self.scene = None # scene object for GUI
Andreas Freise's avatar
Andreas Freise committed
85
        self.verbose = True
86
        self.__blocks = {} # dictionary of blocks that are used
Daniel Brown's avatar
Daniel Brown committed
87
88
89
90
        self.__components = {}  # dictionary of optical components      
        self.__detectors = {}   # dictionary of detectors
        self.__commands = {}    # dictionary of commands
        self.__extra_lines = [] # an array of strings which are just normal finesse code to include when running
Daniel Brown's avatar
Daniel Brown committed
91
92
        self.__gui = None
        self.nodes = NodeNetwork(self)  
93
94
        self.__katdir = katdir
        self.__katname = katname
95
96
        self.__tempdir = tempdir
        self.__tempname = tempname
Daniel Brown's avatar
Daniel Brown committed
97
        self.pykatgui = None
98
99
100
        
        # Various options for running finesse, typicaly the commands with just 1 input
        # and have no name attached to them.
101
102
103
        self.__phase = None
        self.__maxtem = None
        self.__noxaxis = None
104
        self.__time_code = None
Daniel Brown's avatar
Daniel Brown committed
105
        
106
        if kat_code != None and kat_file != None:
107
            raise BasePyKatException("Specify either a Kat file or some Kat code, not both.")
108
109
110
111
112
113
        
        if kat_code != None:
            self.parseCommands(kat_code)
        
        if kat_file != None:
            self.loadKatFile(kat_file)
114
115
116
        
        cls = type(self)
        self.__class__ = type(cls.__name__, (cls,), {})
117
        #self.logo()
118
        
119
120
121
122
123
124
125
126
127
128
    @property
    def maxtem(self): return self.__maxtem
    @maxtem.setter
    def maxtem(self,value): self.__maxtem = int(value)
    
    @property
    def phase(self): return self.__phase
    @phase.setter
    def phase(self,value): self.__phase = int(value)
    
129
130
131
132
133
    @property
    def getPerformanceData(self): return self.__time_code
    @getPerformanceData.setter
    def getPerformanceData(self,value): self.__time_code = bool(value)
    
134
135
136
137
    @property
    def noxaxis(self): return self.__noxaxis
    @noxaxis.setter
    def noxaxis(self,value): self.__noxaxis = bool(value)
138
139
140

    def logo(self):
        print """                                              ..-
141
142
    PyKat                 _                  '(
                          \\`.|\\.__...-\"\"""-_." )
143
144
145
146
147
148
149
       ..+-----.._        /  ' `            .-'
   . '            `:      7/* _/._\\    \\   (
  (        '::;;+;;:      `-"' =" /,`"" `) /
  L.        \\`:::a:f            c_/     n_'
  ..`--...___`.  .    ,  
   `^-....____:   +."""
    
150
    def loadKatFile(self, katfile):
151
152
        commands=open(katfile).read()
        self.parseCommands(commands)
153
    
154
155
    def parseKatCode(self, code):
        #commands = code.split("\n")
156
        self.parseCommands(code)
157
        
158
    def parseCommands(self, commands):
159
        blockComment = False
Andreas Freise's avatar
Andreas Freise committed
160

161
162
163
164
        self.__currentTag= NO_BLOCK
        
        if not (NO_BLOCK in self.__blocks):
            self.__blocks[NO_BLOCK] = Block(NO_BLOCK)
165
        
166
        commands=self.remove_comments(commands)
Andreas Freise's avatar
Andreas Freise committed
167
        
168
169
170
        after_process = [] # list of commands that should be processed after 
                           # objects have been set and created
        
171
        for line in commands.split("\n"):
172
            #for line in commands:
173
174
            if len(line.strip()) >= 2:
                line = line.strip()
175
176

                # Looking for block start or end
177
178
                values = line.split(" ")
                if values[0] == "%%%":
179
180
                    if values[1] == "FTblock":
                        newTag = values[2]
Daniel Brown's avatar
Daniel Brown committed
181
182
                        
                        if self.__currentTag != None and newTag != self.__currentTag: 
183
                            warnings.warn("found block {0} before block {1} ended".format(newTag, self.__currentTag))    
Daniel Brown's avatar
Daniel Brown committed
184
185
186
187
                            
                        if newTag in self.__blocks:
                            raise pkex.BasePyKatException("Block `{0}` has already been read")
                            
188
                        self.__blocks[newTag] = Block(newTag) # create new list to store all references to components in block
189
                        self.__currentTag = newTag                            
Daniel Brown's avatar
Daniel Brown committed
190
                        
191
                    if values[1] == "FTend":
192
                        self.__currentTag = NO_BLOCK
Daniel Brown's avatar
Daniel Brown committed
193
                        
194
                    continue
195
196
                #warnings.warn("current tag {0}".format(self.__currentTag))    

197
198
199
200
201
202
203
204
205
206
207
208
                # don't read comment lines
                if line[0] == "#" or line[0] == "%":
                    continue
                
                # check if block comment is being used
                if not blockComment and line[0:2] == "/*":
                    blockComment = True
                    continue
                elif blockComment and line[0:2] == "*/":
                    blockComment = False
                    continue
                
209
                first = line.split(" ",1)[0]
210
                obj = None
211
                
212
                if(first == "m" or first == "m1" or first == "m2"):
213
                    obj = pykat.components.mirror.parseFinesseText(line)
214
                elif(first == "s"):
215
                    obj = pykat.components.space.parseFinesseText(line)
216
                elif(first == "l"):
217
                    obj = pykat.components.laser.parseFinesseText(line)
Sean Leavey's avatar
Sean Leavey committed
218
219
                elif(first[0:2] == "bs"):
                    obj = pykat.components.beamSplitter.parseFinesseText(line)
220
221
                elif(first[0:2] == "gr"):
                    obj = pykat.components.grating.parseFinesseText(line)
Sean Leavey's avatar
Sean Leavey committed
222
223
                elif(first[0:4] == "isol"):
                    obj = pykat.components.isolator.parseFinesseText(line)
Sean Leavey's avatar
Sean Leavey committed
224
225
                elif(first[0:4] == "lens"):
                    obj = pykat.components.lens.parseFinesseText(line)
Andreas Freise's avatar
Andreas Freise committed
226
227
228
229
                elif(first[0:2] == "pd"):
                    obj = pykat.detectors.photodiode.parseFinesseText(line)
                elif(first == "xaxis" or first == "x2axis" or first == "xaxis*" or first == "x2axis*"):
                    obj = pykat.commands.xaxis.parseFinesseText(line)
230
231
                elif(first == "gauss" or first == "gauss*" or first == "gauss**"):
                    after_process.append(line)
232
                else:
Andreas Freise's avatar
Andreas Freise committed
233
234
                    if self.verbose:
                        print "Parsing `{0}` into pykat object not implemented yet, added as extra line.".format(line)
235
                    obj = line
236
237
                    # manually add the line to the block contents
                    self.__blocks[self.__currentTag].contents.append(line) 
238
                
239
                if obj != None and not isinstance(obj, str):
240
                    self.add(obj)
Daniel Brown's avatar
Daniel Brown committed
241
                    
242
243
244
245
246
247
248
249
        # now process all the varous gauss/attr etc. commands which require
        # components to exist first before they can be processed
        for line in after_process:
            first = line.split(" ",1)[0]
            
            if first == "gauss" or first == "gauss*" or first == "gauss**":
                pykat.commands.gauss.parseFinesseText(line)
            
250
        self.__currentTag = NO_BLOCK 
251
252
253
254
255
256
257
258
259
260
261
262
263
264

    def saveScript(self, filename=None):
        """
        Saves the current kat object to a Finesse input file
        """
        try:
            katScript = "".join(self.generateKatScript())       
            katfile = open(filename,'w')
            katfile.writelines(katScript)
            katfile.flush()
            katfile.close()

        except BasePyKatException as ex:
            print ex
265
            
266
267
268
269
270
271
    def run(self, printout=1, printerr=1, save_output=False, save_kat=False,kat_name=None) :
        """ 
        Runs the current simulation setup that has been built thus far.
        It returns a katRun object which is populated with the various
        data from the simulation run.
        """
272
273
274
        try:
            r = katRun()
            r.katScript = "".join(self.generateKatScript())       
275
            
276
            if len(self.__katdir) == 0:
277
278
279
                # Get the environment variable for where Finesse is stored
                self.__finesse_dir = os.environ.get('FINESSE_DIR')
                
280
                if self.__finesse_dir == None :
281
                    raise MissingFinesseEnvVar()
282
283
284
285
            else:
                self.__finesse_dir = self.__katdir
                
            if len(self.__katname) == 0:
286
287
288
289
                katexe = "kat"
                
                if os.sys.platform == "win32":
                    katexe += ".exe"
290
            else:
291
292
293
                katexe = self.__katname
            
            kat_exec = os.path.join(self.__finesse_dir, katexe) 
294
295
296
            
            # check if kat file exists and it is executable by user        
            if not (os.path.isfile(kat_exec) and os.access(kat_exec, os.X_OK)):
297
                raise MissingFinesse()
298
299
            
            # create a kat file which we will write the script into
300
301
302
303
304
305
            if self.__tempname == None:
                katfile = tempfile.NamedTemporaryFile(suffix=".kat", dir=self.__tempdir)
            else:
                filepath =os.path.join(self.__tempdir, self.__tempname+".kat" )
                katfile = open( filepath, 'w' ) 
                
306
307
            katfile.writelines(r.katScript)
            katfile.flush()
308
            
309
            cmd=[kat_exec, '--perl1']
310
            if self.__time_code:
311
312
313
314
                cmd.append('--perf-timing')
                cmd.append('--no-backspace')

            cmd.append(katfile.name)
Andreas Freise's avatar
Andreas Freise committed
315
316
            if self.verbose:
                print cmd
317
            p=subprocess.Popen(cmd, shell=False, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
318
            err = ""
319
            
320
321
322
            for line in iter(p.stderr.readline, ""):
                err += line
                vals = line.split("-")
323
                
324
325
326
327
328
329
330
331
332
                if len(vals) == 2:
                    action = vals[0].strip()
                    prc = vals[1].strip()[:-1]
                    
                    #sys.stdout.write("\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b")
                    sys.stdout.write("\r{0} {1}%".format(action, prc))
                    sys.stdout.flush()
                
            [out,errpipe] = p.communicate()
Daniel Brown's avatar
Daniel Brown committed
333
            
334
335
336
337
            # get the version number
            ix = out.find('build ') + 6
            ix2 = out.find(')',ix)
            r.katVersion = out[ix:ix2]
Daniel Brown's avatar
Daniel Brown committed
338
            
339
            r.runDateTime = datetime.datetime.now()
Daniel Brown's avatar
Daniel Brown committed
340
            
341
            if p.returncode != 0:
342
                raise FinesseRunError(err, katfile.name)
343
            
344
345
346
347
348
349
350
351
            if printout == 1: print out
            if printerr == 1: print err

            root = os.path.splitext(katfile.name)
            base = os.path.basename(root[0])            
            outfile = root[0] + ".out"
                    
            [r.x,r.y,hdr] = self.readOutFile(outfile)
Daniel Brown's avatar
Daniel Brown committed
352
            
353
354
            r.xlabel = hdr[0]
            r.ylabels = hdr[1:]
Daniel Brown's avatar
Daniel Brown committed
355
            
356
357
358
359
360
361
362
363
364
365
            if save_output:        
                newoutfile = "{0}.out".format(base)
                
                cwd = os.path.os.getcwd()
                newoutfile = os.path.join(cwd,newoutfile)
                
                if os.path.isfile(newoutfile):
                    os.remove(newoutfile)
                    
                os.rename(outfile, newoutfile)
Daniel Brown's avatar
Daniel Brown committed
366

367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
                print "Output data saved to '{0}'".format(newoutfile)
                
            if save_kat:
                if kat_name == None:
                    kat_name = "pykat_output"                
                
                cwd = os.path.os.getcwd()
                newkatfile = os.path.join(cwd, kat_name + ".kat")
                
                if os.path.isfile(newkatfile):
                    os.remove(newkatfile)
                  
                os.rename(katfile.name, newkatfile)         
                
                print "Kat file saved to '{0}'".format(newkatfile)
                

            katfile.close()
            perfData = []
386
            
387
388
389
390
391
392
393
394
395
396
            if self.__time_code:
                perffile = open(root[0] + ".perf",'r')
                
                for l in perffile.readlines():
                    vals = l.strip().split(' ')
                    perfData.append((vals[0], float(vals[1]), float(vals[2]), float(vals[3])))
                    
                return [r, perfData]
            else:
                return r
397
                
398
        except FinesseRunError as fe:
399
400
            print fe
            
Daniel Brown's avatar
Daniel Brown committed
401
        
402
    def add(self, obj):
403
        try:
404
            obj.tag = self.__currentTag
405
            self.__blocks[self.__currentTag].contents.append(obj)
Daniel Brown's avatar
Daniel Brown committed
406
            
407
408
409
            if isinstance(obj, Component):
                
                if obj.name in self.__components :
410
                    raise BasePyKatException("A component with name '{0}' has already been added".format([obj.name]))            
411
412
413
414
415
416
417
                            
                self.__components[obj.name] = obj
                self.__add_component(obj)
                
            elif isinstance(obj, Detector):
                
                if obj.name in self.__detectors :
418
                        raise BasePyKatException("A detector '{0}' has already been added".format(obj.name))
Daniel Brown's avatar
Daniel Brown committed
419
                        
420
421
422
423
424
425
426
427
428
                self.__detectors[obj.name] = obj
                self.__add_detector(obj)
                
            elif isinstance(obj, Command):
                
                self.__commands[obj.__class__.__name__] = obj
                self.__add_command(obj)
                
            else :
429
                raise BasePyKatException("Object {0} could not be added".format(obj))
430
431
                
            obj._on_kat_add(self)
Daniel Brown's avatar
Daniel Brown committed
432
            
433
        except BasePyKatException as ex:
434
            print ex
435

Daniel Brown's avatar
Daniel Brown committed
436
437
438
439
440
441
442
443
444
445
446
    def readOutFile(self, filename):
        
        outfile = open(filename,'r')
        
        # read first to lines to get to header line
        outfile.readline()
        outfile.readline()
        
        hdr = outfile.readline().replace('%','').replace('\n','').split(',')

        data = np.loadtxt(filename,comments='%')
447
        shape_len = len(data.shape)
Daniel Brown's avatar
Daniel Brown committed
448
        
449
450
451
452
453
454
455
456
457
458
        if shape_len > 1:
            rows,cols = data.shape
            x = data[:,0]
            y = data[:,1:cols].squeeze()
        else:
            rows = 1
            cols = data.shape[0]
            
            x = data[0]
            y = data[1:cols].squeeze()
Daniel Brown's avatar
Daniel Brown committed
459
        
460
461
462
        return [x, y, hdr]
            
    def generateKatScript(self) :
Daniel Brown's avatar
Daniel Brown committed
463
        """ Generates the kat file which can then be run """
Daniel Brown's avatar
Daniel Brown committed
464
        
Daniel Brown's avatar
Daniel Brown committed
465
466
        out = []    
        
467
        for key in self.__blocks:
468
            objs = self.__blocks[key].contents
469
470
            
            out.append("%%% FTblock " + key + "\n")
471
            
472
473
            for obj in objs:
                if isinstance(obj, str):
Daniel Brown's avatar
Daniel Brown committed
474
                    out.append(obj + '\n')
475
476
477
478
479
480
                    
                elif isinstance(obj, Component) or isinstance(obj, Detector) or isinstance(obj, Command):
                    txt = obj.getFinesseText() 
                    
                    if txt != None:
                        if isinstance(txt,list):
481
482
                            for t in txt:
                                out.append(t + "\n")
483
484
485
                        else:
                            out.append(txt + "\n")
                            
486
            out.append("%%% FTend " + key + "\n")
Daniel Brown's avatar
Daniel Brown committed
487
488
489
490
        
        if self.noxaxis != None and self.noxaxis == True:
            out.append("noxaxis\n")
            
491
492
493
494
495
496
497
498
499
500
        # now loop through all the nodes and get any gauss commands
        for key in self.nodes.getNodes():
            txt = self.nodes.getNodes()[key].getFinesseText()
            
            if txt != None:
                if isinstance(txt,list):
                    for t in txt: out.append(t+ "\n")
                else:
                    out.append(txt + "\n")
        
Daniel Brown's avatar
Daniel Brown committed
501
502
        if self.phase != None: out.append("phase {0}\n".format(self.phase))
        if self.maxtem != None: out.append("maxtem {0}\n".format(self.maxtem))            
503

Daniel Brown's avatar
Daniel Brown committed
504
505
        # ensure we don't do any plotting. That should be handled
        # by user themselves
Daniel Brown's avatar
Daniel Brown committed
506
507
508
509
510
511
        out.append("gnuterm no\n")
        out.append("pyterm no\n")
        
        return out
        
    def openGUI(self):
Daniel Brown's avatar
Daniel Brown committed
512
513
514
        if NO_GUI:
            print  "No PyQt4 module was installed so cannot open a GUI"
        else:
515
516
517
518
519
520
521
            self.app = QCoreApplication.instance() 
            created = False
            
            if self.app == None:
                created = True
                self.app = QApplication([""])
                
Daniel Brown's avatar
Daniel Brown committed
522
523
524
525
526
            if self.pykatgui == None:
                self.pykatgui = pyKatGUI(self)
                self.pykatgui.main()
            else:
                self.pykatgui.show()
527
528
                
            if created: self.app.exec_()
Daniel Brown's avatar
Daniel Brown committed
529
530
531
532
    
    def getComponents(self):
        return self.__components.values()
    
533
534
535
    def hasComponent(self, name):
        return (name in self.__components)
    
536
    def _newName(self, container, prefix):
537
538
539
        n = 1
        name = "{0}{1}".format(prefix, n)
        
540
        while name in container:
541
542
543
544
545
            n += 1
            name = "{0}{1}".format(prefix,n)
        
        return name
    
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
    def getNewComponentName(self,prefix):
        '''
        Returns a name for a component which hasn't already been added.
        Returns [prefix] + number, where number is greater than 1. e.g.
        if m1 exists getNewName('m') will return 'm2'
        '''
        return self._newName(self.__components, prefix)
    
    def getNewDetectorName(self,prefix):
        '''
        Returns a name for a component which hasn't already been added.
        Returns [prefix] + number, where number is greater than 1. e.g.
        if m1 exists getNewName('m') will return 'm2'
        '''
        return self._newName(self.__detectors, prefix)
        
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
    def getNewNodeNames(self,prefix,N=1):
        '''
        Returns a list of names for N number of nodes which haven't already been added.
        Returns [prefix] + number, where number is greater than 1. e.g.
        if m1 exists getNewName('m') will return 'm2'
        '''
        rtn = []
        n = 1
        
        for M in range(1,N+1):
            name = "{0}{1}".format(prefix, n)
            
            while name in self.nodes.getNodes() or (name in rtn):
                n += 1
                name = "{0}{1}".format(prefix,n)
        
            rtn.append(name)
            
        return rtn
        
Daniel Brown's avatar
Daniel Brown committed
582
583
584
585
    
    def __add_detector(self, det):

        if not isinstance(det, Detector):
586
            raise exceptions.ValueError("Argument is not of type Detector")
Daniel Brown's avatar
Daniel Brown committed
587
588
        
        name = det.name
589
        fget = lambda self: self.__get_detector(name)
Daniel Brown's avatar
Daniel Brown committed
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
        
        setattr(self.__class__, name, property(fget))
        setattr(self, '__det_' + name, det)                   

    def __get_detector(self, name):
        return getattr(self, '__det_' + name) 
        
        
    def __add_command(self, com):

        if not isinstance(com, Command):
            raise exceptions.ValueError("Argument is not of type Command")
        
        name = com.__class__.__name__
        fget = lambda self: self.__get_command(name)
        
        setattr(self.__class__, name, property(fget))
        setattr(self, '__com_' + name, com)                   

    def __get_command(self, name):
        return getattr(self, '__com_' + name)            
    
    def __add_component(self, comp):

        if not isinstance(comp, Component):
            raise exceptions.ValueError("Argument is not of type Component")
            
        fget = lambda self: self.__get_component(comp.name)
        
        setattr(self.__class__, comp.name, property(fget))
        setattr(self, '__comp_' + comp.name, comp)                   

    def __get_component(self, name):
623
        return getattr(self, '__comp_' + name)        
624
625
626
627
628
629
630
631
632
633
634
635
636
637

    def remove_comments(self, string):
        pattern = r"(\".*?\"|\'.*?\'|%{3}[^\r\n]*$)|(/\*.*?\*/|%[^\r\n]*$|#[^\r\n]*$|//[^\r\n]*$)"
        # first group captures quoted strings (double or single)
        # second group captures comments (//single-line or /* multi-line */)
        regex = re.compile(pattern, re.MULTILINE|re.DOTALL)
        def _replacer(match):
            # if the 2nd group (capturing comments) is not None,
            # it means we have captured a non-quoted (real) comment string.
            if match.group(2) is not None:
                return "" # so we will return empty to remove the comment
            else: # otherwise, we will return the 1st group
                return match.group(1) # captured quoted-string
        return regex.sub(_replacer, string)