finesse.py 18.4 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
Daniel Brown's avatar
Daniel Brown committed
35

36
from pykat.exceptions import *
37

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

NO_GUI = False
45
        
46
class katRun(object):
Daniel Brown's avatar
Daniel Brown committed
47
    def __init__(self):
48
49
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
        
    def saveKatRun(self, run, filename):
        if not isinstance(run, katRun):
58
            raise BasePyKatException("run object must be a katRun type")
59
60
61
        
        with open(filename,'w') as outfile:
            pickle.dump(run, outfile, pickle.HIGHEST_PROTOCOL)
Daniel Brown's avatar
Daniel Brown committed
62
    
63
64
65
66
67
68
69
70
    @staticmethod
    def loadKatRun(filename):
        with open(filename,'r') as infile:
            return pickle.load(infile)
        
        
class kat(object):                    
        
71
    def __init__(self, kat_file=None, kat_code=None, katdir="", katname=""):
72
        
73
        self.scene = None # scene object for GUI
Daniel Brown's avatar
Daniel Brown committed
74
75
76
77
        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
78
79
        self.__gui = None
        self.nodes = NodeNetwork(self)  
80
81
        self.__katdir = katdir
        self.__katname = katname
Daniel Brown's avatar
Daniel Brown committed
82
        self.pykatgui = None
Daniel Brown's avatar
Daniel Brown committed
83
        # Various         
84
85
86
        self.__phase = None
        self.__maxtem = None
        self.__noxaxis = None
87
        self.__time_code = None
Daniel Brown's avatar
Daniel Brown committed
88
        
89
        if kat_code != None and kat_file != None:
90
            raise BasePyKatException("Specify either a Kat file or some Kat code, not both.")
91
92
93
94
95
96
97
        
        if kat_code != None:
            self.parseCommands(kat_code)
        
        if kat_file != None:
            self.loadKatFile(kat_file)
            
98
99
100
101
102
103
104
105
106
107
    @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)
    
108
109
110
111
112
    @property
    def getPerformanceData(self): return self.__time_code
    @getPerformanceData.setter
    def getPerformanceData(self,value): self.__time_code = bool(value)
    
113
114
115
116
    @property
    def noxaxis(self): return self.__noxaxis
    @noxaxis.setter
    def noxaxis(self,value): self.__noxaxis = bool(value)
Daniel Brown's avatar
Daniel Brown committed
117
       
118
    def loadKatFile(self, katfile):
Daniel Brown's avatar
Daniel Brown committed
119
        with open(katfile) as f:
120
            self.parseCommands(f.readlines())
121
122
    
    def parseCommands(self, commands):
123
        blockComment = False
124
        currentTag= ""
125
        
126
        for line in commands.split("\n"):
127
128
            if len(line.strip()) >= 2:
                line = line.strip()
129
130
131
132
133
134
135
136
137
138
139
140

                # Looking for block start or end
                if line[0:3] == "%%%":
                    values = text.split(" ")
                    if values[1] == "FTblock":
                        newTag = values[2]
                    if values[1] == "FTend":
                        if currentTag != values[2]:
                            warnings.warn("Found FTend {0} but expected block {1) to end".format(values[2], currentTag))
                        currentTag = ""
                    continue
                    
141
142
143
144
145
146
147
148
149
150
151
152
                # 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
                
153
154
155
156
157
158
159
160
                first = line.split(" ",1)[0]
                
                if(first == "m"):
                    self.add(pykat.components.mirror.parseFinesseText(line))
                elif(first == "s"):
                    self.add(pykat.components.space.parseFinesseText(line))
                elif(first == "l"):
                    self.add(pykat.components.laser.parseFinesseText(line))
161
162
                elif(first == "xaxis" or first == "x2axis" or first == "xaxis*" or first == "x2axis*"):
                    self.add(pykat.commands.xaxis.parseFinesseText(line))
163
                else:
164
                    print "Parsing `{0}` into pykat object not implemented yet, added as extra line.".format(line)
165
166
                    self.__extra_lines.append(line + "\n")
            
167
168
169
170
171
172
    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.
        """
173
174
175
        try:
            r = katRun()
            r.katScript = "".join(self.generateKatScript())       
176
            
177
            if len(self.__katdir) == 0:
178
179
180
                # Get the environment variable for where Finesse is stored
                self.__finesse_dir = os.environ.get('FINESSE_DIR')
                
181
                if self.__finesse_dir == None :
182
                    raise MissingFinesseEnvVar()
183
184
185
186
            else:
                self.__finesse_dir = self.__katdir
                
            if len(self.__katname) == 0:
187
188
189
190
                katexe = "kat"
                
                if os.sys.platform == "win32":
                    katexe += ".exe"
191
            else:
192
193
194
                katexe = self.__katname
            
            kat_exec = os.path.join(self.__finesse_dir, katexe) 
195
196
197
            
            # 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)):
198
                raise MissingFinesse()
199
200
            
            # create a kat file which we will write the script into
201
            katfile = tempfile.NamedTemporaryFile(suffix=".kat")
202
203
            katfile.writelines(r.katScript)
            katfile.flush()
204
            
205
            cmd=[kat_exec, '--perl1']
206
            if self.__time_code:
207
208
209
210
211
                cmd.append('--perf-timing')
                cmd.append('--no-backspace')

            cmd.append(katfile.name)
            p=subprocess.Popen(cmd, shell=False, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
212
            err = ""
213
            
214
215
216
            for line in iter(p.stderr.readline, ""):
                err += line
                vals = line.split("-")
217
                
218
219
220
221
222
223
224
225
226
                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
227
            
228
229
230
231
            # 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
232
            
233
            r.runDateTime = datetime.datetime.now()
Daniel Brown's avatar
Daniel Brown committed
234
            
235
            if p.returncode != 0:
236
                raise FinesseRunError(err, katfile.name)
237
            
238
239
240
241
242
243
244
245
            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
246
            
247
248
            r.xlabel = hdr[0]
            r.ylabels = hdr[1:]
Daniel Brown's avatar
Daniel Brown committed
249
            
250
251
252
253
254
255
256
257
258
259
            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
260

261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
                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 = []
280
            
281
282
283
284
285
286
287
288
289
290
            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
291
                
292
        except FinesseRunError as fe:
293
294
            print fe
            
Daniel Brown's avatar
Daniel Brown committed
295
296
        
    def add(self, obj) :
297
298
299
300
        try:
            if isinstance(obj, Component):
                
                if obj.name in self.__components :
301
                    raise BasePyKatException("A component with name '{0}' has already been added".format([obj.name]))            
302
303
304
305
306
307
308
                            
                self.__components[obj.name] = obj
                self.__add_component(obj)
                
            elif isinstance(obj, Detector):
                
                if obj.name in self.__detectors :
309
                        raise BasePyKatException("A detector '{0}' has already been added".format(obj.name))
Daniel Brown's avatar
Daniel Brown committed
310
                        
311
312
313
314
315
316
317
318
319
                self.__detectors[obj.name] = obj
                self.__add_detector(obj)
                
            elif isinstance(obj, Command):
                
                self.__commands[obj.__class__.__name__] = obj
                self.__add_command(obj)
                
            else :
320
                raise BasePyKatException("Object {0} could not be added".format(obj))
321
322
                
            obj._on_kat_add(self)
Daniel Brown's avatar
Daniel Brown committed
323
            
324
        except BasePyKatException as ex:
325
            print ex
326

Daniel Brown's avatar
Daniel Brown committed
327
328
329
330
331
332
333
334
335
336
337
    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='%')
338
        shape_len = len(data.shape)
Daniel Brown's avatar
Daniel Brown committed
339
        
340
341
342
343
344
345
346
347
348
349
        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
350
        
351
352
353
        return [x, y, hdr]
            
    def generateKatScript(self) :
Daniel Brown's avatar
Daniel Brown committed
354
        """ Generates the kat file which can then be run """
Daniel Brown's avatar
Daniel Brown committed
355
        
Daniel Brown's avatar
Daniel Brown committed
356
357
358
359
360
361
362
363
364
365
366
367
        out = []    
        
        for key in self.__components:       
            txt = self.__components[key].getFinesseText() 
            
            if txt != None:
                if isinstance(txt,list):
                    for t in txt: out.append(t+ "\n")
                else:
                    out.append(txt + "\n")
            
        
368
369
370
371
372
373
374
375
        for key in self.__detectors:
            txt = self.__detectors[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
376
377
378
379
380
381
        
        if self.noxaxis != None and self.noxaxis == True:
            out.append("noxaxis\n")

        for key in self.__commands:        
            if self.noxaxis == None or (self.noxaxis == True and isinstance(self.__commands[key], xaxis)):
382
383
384
385
386
387
388
                txt = self.__commands[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
389
            
390
391
392
393
394
395
396
397
398
399
        # 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
400
401
402
        if self.phase != None: out.append("phase {0}\n".format(self.phase))
        if self.maxtem != None: out.append("maxtem {0}\n".format(self.maxtem))            
        
Daniel Brown's avatar
Daniel Brown committed
403
404
405
406
407
408
409
410
411
        # There maybe extra lines we want to include in the kat
        # script which aren't parseable into components, detectors
        # or commands. Typically when something hasn't been fully
        # supported yet. So bung these extra lines on at the end
        for lines in self.__extra_lines:
            out.append(lines)
        
        # ensure we don't do any plotting. That should be handled
        # by user themselves
Daniel Brown's avatar
Daniel Brown committed
412
413
414
415
416
417
        out.append("gnuterm no\n")
        out.append("pyterm no\n")
        
        return out
        
    def openGUI(self):
Daniel Brown's avatar
Daniel Brown committed
418
419
420
421
422
423
424
425
426
        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
427
428
429
430
    
    def getComponents(self):
        return self.__components.values()
    
431
432
433
    def hasComponent(self, name):
        return (name in self.__components)
    
434
    def _newName(self, container, prefix):
435
436
437
        n = 1
        name = "{0}{1}".format(prefix, n)
        
438
        while name in container:
439
440
441
442
443
            n += 1
            name = "{0}{1}".format(prefix,n)
        
        return name
    
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
    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)
        
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
    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
480
481
482
483
    
    def __add_detector(self, det):

        if not isinstance(det, Detector):
484
            raise exceptions.ValueError("Argument is not of type Detector")
Daniel Brown's avatar
Daniel Brown committed
485
486
        
        name = det.name
487
        fget = lambda self: self.__get_detector(name)
Daniel Brown's avatar
Daniel Brown committed
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
        
        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):
521
        return getattr(self, '__comp_' + name)