finesse.py 20.6 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
45
from pykat.gui.gui import pyKatGUI

NO_GUI = False
46
47
NO_BLOCK = "NO_BLOCK"

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

142
143
144
145
        self.__currentTag= NO_BLOCK
        
        if not (NO_BLOCK in self.__blocks):
            self.__blocks[NO_BLOCK] = Block(NO_BLOCK)
146
        
147
        commands=self.remove_comments(commands)
Andreas Freise's avatar
Andreas Freise committed
148
        
149
        for line in commands.split("\n"):
150
            #for line in commands:
151
152
            if len(line.strip()) >= 2:
                line = line.strip()
153
154

                # Looking for block start or end
155
156
                values = line.split(" ")
                if values[0] == "%%%":
157
158
                    if values[1] == "FTblock":
                        newTag = values[2]
Daniel Brown's avatar
Daniel Brown committed
159
160
                        
                        if self.__currentTag != None and newTag != self.__currentTag: 
161
                            warnings.warn("found block {0} before block {1} ended".format(newTag, self.__currentTag))    
Daniel Brown's avatar
Daniel Brown committed
162
163
164
165
                            
                        if newTag in self.__blocks:
                            raise pkex.BasePyKatException("Block `{0}` has already been read")
                            
166
                        self.__blocks[newTag] = Block(newTag) # create new list to store all references to components in block
167
                        self.__currentTag = newTag                            
Daniel Brown's avatar
Daniel Brown committed
168
                        
169
                    if values[1] == "FTend":
170
                        self.__currentTag = NO_BLOCK
Daniel Brown's avatar
Daniel Brown committed
171
                        
172
                    continue
173
174
                #warnings.warn("current tag {0}".format(self.__currentTag))    

175
176
177
178
179
180
181
182
183
184
185
186
                # 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
                
187
                first = line.split(" ",1)[0]
188
                obj = None
189
190
                
                if(first == "m"):
191
                    obj = pykat.components.mirror.parseFinesseText(line)
192
                elif(first == "s"):
193
                    obj = pykat.components.space.parseFinesseText(line)
194
                elif(first == "l"):
195
                    obj = pykat.components.laser.parseFinesseText(line)
Andreas Freise's avatar
Andreas Freise committed
196
197
198
199
                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)
200
                else:
201
                    print "Parsing `{0}` into pykat object not implemented yet, added as extra line.".format(line)
202
                    obj = line
203
204
                    # manually add the line to the block contents
                    self.__blocks[self.__currentTag].contents.append(line) 
Andreas Freise's avatar
Andreas Freise committed
205
                print obj
206
                if not isinstance(obj, str):
207
                    self.add(obj)
Daniel Brown's avatar
Daniel Brown committed
208
                    
209
        self.__currentTag = NO_BLOCK 
210
            
211
212
213
214
215
216
    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.
        """
217
218
219
        try:
            r = katRun()
            r.katScript = "".join(self.generateKatScript())       
220
            
221
            if len(self.__katdir) == 0:
222
223
224
                # Get the environment variable for where Finesse is stored
                self.__finesse_dir = os.environ.get('FINESSE_DIR')
                
225
                if self.__finesse_dir == None :
226
                    raise MissingFinesseEnvVar()
227
228
229
230
            else:
                self.__finesse_dir = self.__katdir
                
            if len(self.__katname) == 0:
231
232
233
234
                katexe = "kat"
                
                if os.sys.platform == "win32":
                    katexe += ".exe"
235
            else:
236
237
238
                katexe = self.__katname
            
            kat_exec = os.path.join(self.__finesse_dir, katexe) 
239
240
241
            
            # 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)):
242
                raise MissingFinesse()
243
244
            
            # create a kat file which we will write the script into
245
246
247
248
249
250
            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' ) 
                
251
252
            katfile.writelines(r.katScript)
            katfile.flush()
253
            
254
            cmd=[kat_exec, '--perl1']
255
            if self.__time_code:
256
257
258
259
                cmd.append('--perf-timing')
                cmd.append('--no-backspace')

            cmd.append(katfile.name)
260
            print cmd
261
            p=subprocess.Popen(cmd, shell=False, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
262
            err = ""
263
            
264
265
266
            for line in iter(p.stderr.readline, ""):
                err += line
                vals = line.split("-")
267
                
268
269
270
271
272
273
274
275
276
                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
277
            
278
279
280
281
            # 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
282
            
283
            r.runDateTime = datetime.datetime.now()
Daniel Brown's avatar
Daniel Brown committed
284
            
285
            if p.returncode != 0:
286
                raise FinesseRunError(err, katfile.name)
287
            
288
289
290
291
292
293
294
295
            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
296
            
297
298
            r.xlabel = hdr[0]
            r.ylabels = hdr[1:]
Daniel Brown's avatar
Daniel Brown committed
299
            
300
301
302
303
304
305
306
307
308
309
            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
310

311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
                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 = []
330
            
331
332
333
334
335
336
337
338
339
340
            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
341
                
342
        except FinesseRunError as fe:
343
344
            print fe
            
Daniel Brown's avatar
Daniel Brown committed
345
        
346
    def add(self, obj):
347
        try:
348
            obj.tag = self.__currentTag
349
            self.__blocks[self.__currentTag].contents.append(obj)
Daniel Brown's avatar
Daniel Brown committed
350
            
351
352
353
            if isinstance(obj, Component):
                
                if obj.name in self.__components :
354
                    raise BasePyKatException("A component with name '{0}' has already been added".format([obj.name]))            
355
356
357
358
359
360
361
                            
                self.__components[obj.name] = obj
                self.__add_component(obj)
                
            elif isinstance(obj, Detector):
                
                if obj.name in self.__detectors :
362
                        raise BasePyKatException("A detector '{0}' has already been added".format(obj.name))
Daniel Brown's avatar
Daniel Brown committed
363
                        
364
365
366
367
368
369
370
371
372
                self.__detectors[obj.name] = obj
                self.__add_detector(obj)
                
            elif isinstance(obj, Command):
                
                self.__commands[obj.__class__.__name__] = obj
                self.__add_command(obj)
                
            else :
373
                raise BasePyKatException("Object {0} could not be added".format(obj))
374
375
                
            obj._on_kat_add(self)
Daniel Brown's avatar
Daniel Brown committed
376
            
377
        except BasePyKatException as ex:
378
            print ex
379

Daniel Brown's avatar
Daniel Brown committed
380
381
382
383
384
385
386
387
388
389
390
    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='%')
391
        shape_len = len(data.shape)
Daniel Brown's avatar
Daniel Brown committed
392
        
393
394
395
396
397
398
399
400
401
402
        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
403
        
404
405
406
        return [x, y, hdr]
            
    def generateKatScript(self) :
Daniel Brown's avatar
Daniel Brown committed
407
        """ Generates the kat file which can then be run """
Daniel Brown's avatar
Daniel Brown committed
408
        
Daniel Brown's avatar
Daniel Brown committed
409
410
        out = []    
        
411
        for key in self.__blocks:
412
            objs = self.__blocks[key].contents
413
414
            
            out.append("%%% FTblock " + key + "\n")
415
            
416
417
            for obj in objs:
                if isinstance(obj, str):
Daniel Brown's avatar
Daniel Brown committed
418
                    out.append(obj + '\n')
419
420
421
422
423
424
425
426
427
428
                    
                elif isinstance(obj, Component) or isinstance(obj, Detector) or isinstance(obj, Command):
                    txt = obj.getFinesseText() 
                    
                    if txt != None:
                        if isinstance(txt,list):
                            for t in txt: out.append(t + "\n")
                        else:
                            out.append(txt + "\n")
                            
429
            out.append("%%% FTend " + key + "\n")
Daniel Brown's avatar
Daniel Brown committed
430
431
432
433
        
        if self.noxaxis != None and self.noxaxis == True:
            out.append("noxaxis\n")
            
434
435
436
437
438
439
440
441
442
443
        # 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
444
445
        if self.phase != None: out.append("phase {0}\n".format(self.phase))
        if self.maxtem != None: out.append("maxtem {0}\n".format(self.maxtem))            
446

Daniel Brown's avatar
Daniel Brown committed
447
448
        # ensure we don't do any plotting. That should be handled
        # by user themselves
Daniel Brown's avatar
Daniel Brown committed
449
450
451
452
453
454
        out.append("gnuterm no\n")
        out.append("pyterm no\n")
        
        return out
        
    def openGUI(self):
Daniel Brown's avatar
Daniel Brown committed
455
456
457
458
459
460
461
462
463
        if NO_GUI:
            print  "No PyQt4 module was installed so cannot open a GUI"
        else:
            if self.pykatgui == None:
                #self.app = QtGui.QApplication([""])
                self.pykatgui = pyKatGUI(self)
                self.pykatgui.main()
            else:
                self.pykatgui.show()
Daniel Brown's avatar
Daniel Brown committed
464
465
466
467
    
    def getComponents(self):
        return self.__components.values()
    
468
469
470
    def hasComponent(self, name):
        return (name in self.__components)
    
471
    def _newName(self, container, prefix):
472
473
474
        n = 1
        name = "{0}{1}".format(prefix, n)
        
475
        while name in container:
476
477
478
479
480
            n += 1
            name = "{0}{1}".format(prefix,n)
        
        return name
    
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
    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)
        
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
    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
517
518
519
520
    
    def __add_detector(self, det):

        if not isinstance(det, Detector):
521
            raise exceptions.ValueError("Argument is not of type Detector")
Daniel Brown's avatar
Daniel Brown committed
522
523
        
        name = det.name
524
        fget = lambda self: self.__get_detector(name)
Daniel Brown's avatar
Daniel Brown committed
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
        
        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):
558
        return getattr(self, '__comp_' + name)        
559
560
561
562
563
564
565
566
567
568
569
570
571
572

    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)