finesse.py 50.7 KB
Newer Older
Daniel Brown's avatar
Daniel Brown committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# -*- coding: utf-8 -*-
"""
Created on Sun Jan 27 09:56:53 2013

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
"""
import sys
import os
import subprocess
import tempfile
import numpy as np
import datetime
import pickle
import pykat
import warnings
import re
36
import math
Daniel Brown's avatar
Daniel Brown committed
37

Daniel Brown's avatar
Daniel Brown committed
38
import itertools
Daniel Brown's avatar
Daniel Brown committed
39
import ctypes
Daniel Brown's avatar
Daniel Brown committed
40
import ctypes.util
Daniel Brown's avatar
Daniel Brown committed
41
import collections
42
from collections import namedtuple, OrderedDict
43

Daniel Brown's avatar
Daniel Brown committed
44
45
46
47
48
from pykat.node_network import NodeNetwork
from pykat.detectors import Detector
from pykat.components import Component
from pykat.commands import Command, xaxis
from pykat.gui.gui import pyKatGUI
49
from pykat.SIfloat import *
50
from pykat.param import Param, AttrParam
Daniel Brown's avatar
Daniel Brown committed
51
52
53
54
55
56

import pykat.exceptions as pkex

from PyQt4.QtCore import QCoreApplication
from PyQt4.QtGui import QApplication

Daniel Brown's avatar
Daniel Brown committed
57
58
from multiprocessing import Process, Manager

Daniel Brown's avatar
Daniel Brown committed
59
60
NO_GUI = False
NO_BLOCK = "NO_BLOCK"
61
62
pykat_web = "www.gwoptics.org/pykat"

Daniel Brown's avatar
Daniel Brown committed
63
64
65
66
67
68
69
# containers used in the trace routine
space_trace = namedtuple("space_trace", ['gouyx','gouyy'])
node_trace = namedtuple("node_trace", ['qx','qy'])
cav_trace = namedtuple("cav_trace", ['isStable','gx','gy','qx','qy','finesse','loss','length','FSR','FWHM','pole'])
         
lkat_location = ctypes.util.find_library("kat")
                                     
Daniel Brown's avatar
Daniel Brown committed
70
71
72
def f__lkat_process(callback, cmd, kwargs):
    """
    """
Daniel Brown's avatar
Daniel Brown committed
73
74
75
76
77
    
    if lkat_location == None:
        raise RuntimeError("Could not find shared library 'libkat', please install to a system location or copy to the same directory as this script")
        
    lkat = ctypes.PyDLL(lkat_location)
Daniel Brown's avatar
Daniel Brown committed
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

    try:
        lkat._pykat_preInit() # must always be called, sets up
                        # exception handling and such no simulation
                        # specifc code here

        # reads in the kat.ini and setups up other parts
        lkat._pykat_init()
        lkat._pykat_setup(cmd)
    
        callback(lkat, **kwargs)
    
    except Exception as ex: 
        print "Exception caught in python: ", ex.message
    finally:
        # This should always be called no matter what
        lkat._pykat_finish(0)
Daniel Brown's avatar
Daniel Brown committed
95
96


97
def f__lkat_trace_callback(lkat, trace_info, getCavities, getNodes, getSpaces):
Daniel Brown's avatar
Daniel Brown committed
98
99
100
101
102
103
104
105
106
107
108
109
    """
    lkat callback for computing the beam traces through a setup.
    Returns a dictionary of nodes, spaces and cavities and the
    various outputs of the tracing algorithm.
    """
    import pylibkat

    # first we need to get a handle on the internals of Finesse
    inter = pylibkat.interferometer.in_dll(lkat, "inter")

    lkat._pykat_step()

110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
    if getNodes:
        for n in range(0, inter.num_nodes):
            node = inter.node_list[n]

            node_info = node_trace(
                                    qx = complex(node.qx.re, node.qx.im),
                                    qy = complex(node.qy.re, node.qy.im)
                                    )

            trace_info[node.name] = node_info

    if getCavities:
        for c in range(0, inter.num_cavities):
            cav = inter.cavity_list[c]

            cav_info = cav_trace(
                                isStable = (cav.stable == 1),
                                gx = cav.stability_x,
                                gy = cav.stability_y,
                                qx = complex(cav.qx.re, cav.qx.im),
                                qy = complex(cav.qy.re, cav.qy.im),
                                finesse = cav.finesse,
                                FSR = cav.FSR,
                                FWHM = cav.FWHM,
                                loss = cav.loss,
                                length = cav.length,
                                pole = cav.pole
Daniel Brown's avatar
Daniel Brown committed
137
138
                                )

139
            trace_info[cav.name] = cav_info
Daniel Brown's avatar
Daniel Brown committed
140

141
142
143
    if getSpaces:
        for s in range(0, inter.num_spaces):
            space = inter.space_list[s]
Daniel Brown's avatar
Daniel Brown committed
144

145
146
            trace_info[space.name] = space_trace(gouyx = space.gouy_x,
                                                 gouyy = space.gouy_y)
Daniel Brown's avatar
Daniel Brown committed
147
148
                     
                                             
Daniel Brown's avatar
Daniel Brown committed
149
150
151
152
153
154
155
156
157
class katRun(object):
    def __init__(self):
        self.runDateTime = datetime.datetime.now()
        self.x = None
        self.y = None
        self.xlabel = None
        self.ylabels = None
        self.katScript = None
        self.katVersion = None
158
        self.yaxis = None
Daniel Brown's avatar
Daniel Brown committed
159
        
160
    def savekatRun(self, filename):
Daniel Brown's avatar
Daniel Brown committed
161
162
163
164
165
166
167
168
169
170
171
        with open(filename,'w') as outfile:
            pickle.dump(self, outfile)
    
    @staticmethod
    def loadKatRun(filename):
        with open(filename,'r') as infile:
            return pickle.load(infile)
    
    def get(self, value): return self[value]
    
    def __getitem__(self, value):
172
        idx = [i for i in range(len(self.ylabels)) if self.ylabels[i].split()[0] == str(value)]
Daniel Brown's avatar
Daniel Brown committed
173
        
174
175
176
        
        if len(idx) > 0:
            out = self.y[:, idx]
177
            
178
179
180
181
182
183
184
            if self.yaxis == "abs:deg":
                out = self.y[:, idx[0]] * np.exp(1j*math.pi*self.y[:, idx[1]]/180.0)
            elif self.yaxis == "re:im":
                out = self.y[:, idx[0]] + 1j*self.y[:, idx[1]]
            
            out.squeeze()
            
185
            if out.size == 1:
186
                return out[0]
187
            else:
188
                return out
Daniel Brown's avatar
Daniel Brown committed
189
        else:
190
            raise  pkex.BasePyKatException("No output by the name '{0}' found in the output".format(str(value)))
Daniel Brown's avatar
Daniel Brown committed
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
      
class katRun2D(object):
    def __init__(self):
        self.runDateTime = datetime.datetime.now()
        self.x = None
        self.y = None
        self.z = None
        self.xlabel = None
        self.ylabel = None
        self.zlabels = None
        self.katScript = None
        self.katVersion = None
        
    def saveKatRun(self, filename):
        with open(filename,'w') as outfile:
            pickle.dump(self, outfile)
    
    @staticmethod
    def loadKatRun(filename):
        with open(filename,'r') as infile:
            return pickle.load(infile)
    
    def get(self, value): return self[value]
    
    def __getitem__(self, value):
216
        idx = [i for i in range(len(self.zlabels)) if self.zlabels[i].split()[0] == str(value)]
Daniel Brown's avatar
Daniel Brown committed
217
218
219
220
221
        
        if len(idx) > 0:
            return self.z[idx].squeeze()
        else:
            raise  pkex.BasePyKatException("No output by the name {0} found".format(str(value)))
222
    
223
        
224
225
class Signals(object):
    class fsig(object):
226
227
228
229
230
231
        def __init__(self, param, name, amplitude, phase):
            self._params = []
            self.__target = param
            self.__name = name
            self.__amplitude = Param("amp", self, SIfloat(amplitude))
            self.__phase = Param("phase", self, SIfloat(phase))
232
            self.__removed = False
233
234
235
236
237
238
            
            # unfortunatenly the target names for fsig are not the same as the
            # various parameter names of the components, e.g. mirror xbeta is x 
            # for fsig. So we need to check here what type of component we are targetting
            # and then based on the parameter specfied get the name
            if not param.canFsig:
239
                raise  pkex.BasePyKatException("Cannot fsig parameter {1} on component {0}".format(str(param._owner().name), param.name))
240
241
242
            
        def _register_param(self, param):
            self._params.append(param)
243
244
245
        
        @property
        def removed(self): return self.__removed
246
  
247
248
249
250
251
252
        def remove(self):
            if self.__removed:
                raise pkex.BasePyKatException("Signal {0} has already been marked as removed".format(self.name))
            else:
                self._kat.remove(self)
        
253
254
255
256
257
        @property
        def name(self): return self.__name

        @property
        def amplitude(self): return self.__amplitude
258
259
260
        @amplitude.setter
        def amplitude(self,value): self.__amplitude.value = SIfloat(value)

261
262
263

        @property
        def phase(self): return self.__phase
264
265
        @phase.setter
        def phase(self,value): self.__phase.value = SIfloat(value)
266
267
268
269
270

        @property
        def target(self): return self.__target.fsig_name

        @property
271
        def owner(self): return self.__target._owner().name
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
    
        def getFinesseText(self):
            rtn = []
    
            for p in self._params:
                rtn.extend(p.getFinesseText())
        
            return rtn
    
    @property
    def name(self):
        # if we don't have any signals yet then use a dummy name
        # however we need to always tune a real fsig command
        # so need to get the name of at least one of them
        # as if you tune one you tune them all
        if len(self.targets) == 0:
288
            return "fsignal"
289
290
        else:
            return self.targets[0].name
291
292
293
294
            
    @property
    def removed(self): return False # we can never remove the Signal object altogethr just the
                                    # individual fsig targets
295

296
297
298
299
    def remove(self):
        for t in self.targets:
            self._kat.remove(self)
            
300
301
    @property
    def f(self): return self.__f
302
303
    @f.setter
    def f(self,value): self.__f.value = SIfloat(value)
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
    
    def __init__(self):

        self.targets = []
        self._params = []
        
        self.__f = Param("f", self, 1)
    
    def _register_param(self, param):
        self._params.append(param)
        
    def apply(self, target, amplitude, phase, name=None):
        
        if target == None:
            raise  pkex.BasePyKatException("No target was specified for signal to be applied")
        
        if name == None:
321
            name = "sig_" + target._owner().name + "_" + target.name
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
        
        self.targets.append(Signals.fsig(target, name, amplitude, phase))
        
    def getFinesseText(self):
        rtn = []
        
        for t in self.targets:
            rtn.extend(t.getFinesseText())
            rtn.append("fsig {name} {comp} {target} {frequency} {phase} {amplitude}".format(name = t.name, comp=t.owner, target=t.target, frequency=str(self.f), phase=str(t.phase), amplitude=str(t.amplitude)))
        
        for p in self._params:
            rtn.extend(p.getFinesseText())
        
        return rtn
        
        
Daniel Brown's avatar
Daniel Brown committed
338
339
340
341
342
343
344
345
346
class Block:
    def __init__(self, name):
        self.__name = name
        self.contents = [] # List of objects and strings of finesse code
        self.enabled = True 
        
    @property
    def name(self): return self.__name
    
347
348
349
Constant = namedtuple('Constant', 'name, value, usedBy')
    
class kat(object):  
Daniel Brown's avatar
Daniel Brown committed
350
351
352
353
354
        
    def __init__(self, kat_file=None, kat_code=None, katdir="", katname="", tempdir=None, tempname=None):
        
        self.scene = None # scene object for GUI
        self.verbose = True
355
        self.__blocks = OrderedDict() # dictionary of blocks that are used
Daniel Brown's avatar
Daniel Brown committed
356
357
358
359
360
361
362
363
364
365
        self.__components = {}  # dictionary of optical components      
        self.__detectors = {}   # dictionary of detectors
        self.__commands = {}    # dictionary of commands
        self.__gui = None
        self.nodes = NodeNetwork(self)  
        self.__katdir = katdir
        self.__katname = katname
        self.__tempdir = tempdir
        self.__tempname = tempname
        self.pykatgui = None
366
        self.__signals = Signals()
367
        self.constants = {}
368
        self.vacuum = []
369
370
371
372
        
        # initialise default block
        self.__currentTag= NO_BLOCK
        self.__blocks[NO_BLOCK] = Block(NO_BLOCK)
Daniel Brown's avatar
Daniel Brown committed
373
374
375
        
        # Various options for running finesse, typicaly the commands with just 1 input
        # and have no name attached to them.
376
377
        self.retrace = None
        self.deriv_h = None
378
        self.scale = None
Sean Leavey's avatar
Sean Leavey committed
379
        self.__trace = None
Daniel Brown's avatar
Daniel Brown committed
380
381
382
383
        self.__phase = None
        self.__maxtem = None
        self.__noxaxis = None
        self.__time_code = None
384
        self.__yaxis = "abs" # default yaxis
Daniel Brown's avatar
Daniel Brown committed
385
386
387
388
389
390
391
392
393
394
395
396
        
        if kat_code != None and kat_file != None:
            raise pkex.BasePyKatException("Specify either a Kat file or some Kat code, not both.")
        
        if kat_code != None:
            self.parseCommands(kat_code)
        
        if kat_file != None:
            self.loadKatFile(kat_file)
        
        cls = type(self)
        self.__class__ = type(cls.__name__, (cls,), {})
Daniel Brown's avatar
Daniel Brown committed
397

398
399
400
    @property
    def signals(self): return self.__signals

401
402
403
404
405
406
407
408
409
410
411
    yaxis_options = ["abs:deg","db:deg","re:im","abs","db","deg"]
    @property
    def yaxis(self): return self.__yaxis
    @yaxis.setter
    def yaxis(self, value):
        
        if not str(value) in self.yaxis_options:
            raise pkex.BasePyKatException("yaxis value '{0}' is not a value option. Valid options are: {1}".format(str(value), ",".join(self.yaxis_options) ))
            
        self.__yaxis = str(value)

Sean Leavey's avatar
Sean Leavey committed
412
413
414
415
416
417
418
419
420
421
422
    @property
    def trace(self): return self.__trace
    @trace.setter
    def trace(self, value):
        value = int(value)

        if value < 0 or value > 255:
            raise pkex.BasePyKatException('trace command only accepts values in the range 0-255.')
        else:
            self.__trace = value

Daniel Brown's avatar
Daniel Brown committed
423
424
425
    @property
    def maxtem(self): return self.__maxtem
    @maxtem.setter
426
427
428
429
430
    def maxtem(self,value):
        if value == "off":
            self.__maxtem = -1
        else:
            self.__maxtem = int(value)
Daniel Brown's avatar
Daniel Brown committed
431
432
433
434
435
    
    @property
    def phase(self): return self.__phase
    @phase.setter
    def phase(self,value): self.__phase = int(value)
436
        
Daniel Brown's avatar
Daniel Brown committed
437
438
439
440
441
    @property
    def getPerformanceData(self): return self.__time_code
    @getPerformanceData.setter
    def getPerformanceData(self,value): self.__time_code = bool(value)
    
Daniel Brown's avatar
Daniel Brown committed
442
443
444
445
446
447
448
449
    @property
    def components(self):
        return self.__components.copy()
    
    @property
    def detectors(self):
        return self.__detectors.copy()
        
Daniel Brown's avatar
Daniel Brown committed
450
451
452
    @property
    def noxaxis(self): return self.__noxaxis
    @noxaxis.setter
453
    def noxaxis(self,value): self.__noxaxis = bool(value) 
Daniel Brown's avatar
Daniel Brown committed
454

455
456
    @staticmethod
    def logo():
Daniel Brown's avatar
Daniel Brown committed
457
        print """                                              ..-
458
    PyKat {0:7}         _                  '(
Daniel Brown's avatar
Daniel Brown committed
459
460
461
462
463
464
                          \\`.|\\.__...-\"\"""-_." )
       ..+-----.._        /  ' `            .-'
   . '            `:      7/* _/._\\    \\   (
  (        '::;;+;;:      `-"' =" /,`"" `) /
  L.        \\`:::a:f            c_/     n_'
  ..`--...___`.  .    ,  
Daniel Brown's avatar
Daniel Brown committed
465
   `^-....____:   +.      {1}""".format(pykat.__version__, pykat_web)
Daniel Brown's avatar
Daniel Brown committed
466
467
468
469
470
471
472
473
    
    def loadKatFile(self, katfile):
        commands=open(katfile).read()
        self.parseCommands(commands)
    
    def parseKatCode(self, code):
        #commands = code.split("\n")
        self.parseCommands(code)
474
475
476
477
478
479
480
481
482

    def processConstants(self, commands):
        """
        Before fully parsing a bunch of commands firstly any constants or variables
        to be recorded and replaced.
        """
        constants = self.constants
        
        for line in commands:
483
            values = line.split()
484
485
486
            
            if len(values)>0 and values[0] == 'const':
                
Daniel Brown's avatar
Daniel Brown committed
487
                if len(values) >= 3:
488
489
490
                    if values[1] in constants:
                        raise pkex.BasePyKatException('const command with the name "{0}" already used'.format(values[1]))
                    else:
Daniel Brown's avatar
Daniel Brown committed
491
                        constants[str(values[1])] = Constant(values[1], values[2], [])
492
493
494
495
496
497
                else:
                    raise pkex.BasePyKatException('const command "{0}" was not the correct format'.format(line))
        
        commands_new = []
        
        for line in commands:
498
            values = line.split()
499
            
500
            if len(values) > 0 and values[0] != 'const':
501
502
503
                # check if we have a var/constant in this line
                if line.find('$') >= 0:
                    for key in constants.keys():
504
505
506
507
                        if line.find('$'+key+' ') > -1:
                            constants[key].usedBy.append(line)
                            line = line.replace('$'+key+' ', str(constants[key].value)+ ' ')
                        elif line.endswith('$'+key):
508
509
510
511
512
513
514
515
                            constants[key].usedBy.append(line)
                            line = line.replace('$'+key, str(constants[key].value))
                        
                commands_new.append(line)
    
        self.constants = constants
        
        return commands_new
Daniel Brown's avatar
Daniel Brown committed
516
517
518
519
520
        
    def parseCommands(self, commands):
        blockComment = False
        
        commands=self.remove_comments(commands)
521
522
        
        commands=self.processConstants(commands)
Daniel Brown's avatar
Daniel Brown committed
523
524
525
526
        
        after_process = [] # list of commands that should be processed after 
                           # objects have been set and created
        
527
        for line in commands:
Daniel Brown's avatar
Daniel Brown committed
528
529
530
531
532
            #for line in commands:
            if len(line.strip()) >= 2:
                line = line.strip()

                # Looking for block start or end
533
                values = line.split()
Daniel Brown's avatar
Daniel Brown committed
534
535
536
537
                if values[0] == "%%%":
                    if values[1] == "FTblock":
                        newTag = values[2]
                        
538
                        if self.__currentTag != None and self.__currentTag != NO_BLOCK: 
Daniel Brown's avatar
Daniel Brown committed
539
540
541
                            warnings.warn("found block {0} before block {1} ended".format(newTag, self.__currentTag))    
                            
                        if newTag in self.__blocks:
Daniel Brown's avatar
Daniel Brown committed
542
                            raise pkex.BasePyKatException("Block `{0}` has already been read".format(newTag))
Daniel Brown's avatar
Daniel Brown committed
543
544
                            
                        self.__blocks[newTag] = Block(newTag) # create new list to store all references to components in block
545
                        self.__currentTag = newTag
Daniel Brown's avatar
Daniel Brown committed
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
                        
                    if values[1] == "FTend":
                        self.__currentTag = NO_BLOCK
                        
                    continue
                #warnings.warn("current tag {0}".format(self.__currentTag))    

                # 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
                
                first = line.split(" ",1)[0]
                obj = None
                if(first == "m" or first == "m1" or first == "m2"):
                    obj = pykat.components.mirror.parseFinesseText(line)
                elif(first == "s"):
                    obj = pykat.components.space.parseFinesseText(line)
                elif(first == "l"):
                    obj = pykat.components.laser.parseFinesseText(line)
                elif(first[0:2] == "bs"):
                    obj = pykat.components.beamSplitter.parseFinesseText(line)
                elif(first[0:2] == "gr"):
                    obj = pykat.components.grating.parseFinesseText(line)
                elif(first[0:4] == "isol"):
                    obj = pykat.components.isolator.parseFinesseText(line)
                elif(first[0:4] == "lens"):
                    obj = pykat.components.lens.parseFinesseText(line)
                elif(first[0:3] == "mod"):
                    obj = pykat.components.modulator.parseFinesseText(line)
Daniel Brown's avatar
Daniel Brown committed
583
584
                elif(first[0:2] == "ad"):
                    obj = pykat.detectors.ad.parseFinesseText(line)
585
                elif(first[0:2] == "pd" and first != "pdtype"):
586
                    obj = pykat.detectors.pd.parseFinesseText(line)
Daniel Brown's avatar
Daniel Brown committed
587
588
589
590
                elif(first == "qshot"):
                    obj = pykat.detectors.qshot.parseFinesseText(line)
                elif(first == "qnoised"):
                    obj = pykat.detectors.qnoised.parseFinesseText(line)
Daniel Brown's avatar
Daniel Brown committed
591
592
593
594
595
596
                elif(first == "xaxis" or first == "xaxis*"):
                    obj = pykat.commands.xaxis.parseFinesseText(line)
                elif(first == "x2axis" or first == "x2axis*"):
                    obj = pykat.commands.x2axis.parseFinesseText(line)
                elif(first == "gauss" or first == "gauss*" or first == "gauss**"):
                    after_process.append(line)
597
598
                elif(first == "scale"):
                    after_process.append(line)
599
600
                elif(first == "pdtype"):
                    after_process.append(line)
Daniel Brown's avatar
Daniel Brown committed
601
602
                elif(first == "attr"):
                    after_process.append(line)
Daniel Brown's avatar
Daniel Brown committed
603
604
                elif(first == "noxaxis"):
                    self.noxaxis = True
605
606
607
608
                elif(first == "yaxis"):
                    v = line.split()
                    
                    self.yaxis = v[-1]
609
                elif(first == "phase"):
610
                    v = line.split()
611
                    if len(v) != 2:
612
                        raise pkex.BasePyKatException("phase command `{0}` is incorrect.".format(line))
613
614
                    else:
                        self.phase = int(v[1])
615
                elif(first == "maxtem"):
616
                    v = line.split()
617
618
619
                    if len(v) != 2:
                        raise pkex.BasePyKatException("maxtem command `{0}` is incorrect.".format(line))
                    else:
620
621
622
                        if v[1] == "off":
                        	self.maxtem = -1
                        else:
623
	                        self.maxtem = int(v[1])
Sean Leavey's avatar
Sean Leavey committed
624
625
626
627
628
629
                elif(first == "trace"):
                    v = line.split()
                    if len(v) > 2:
                        raise pkex.BasePyKatException("Trace command `{0}` is incorrect.".format(line))
                    elif len(v) == 2:
                        self.trace = v[1]
630
                elif(first == "retrace"):
631
                    v = line.split()
Daniel Brown's avatar
Daniel Brown committed
632
                    if len(v) > 2:
633
                        raise pkex.BasePyKatException("Retrace command `{0}` is incorrect.".format(line))
Daniel Brown's avatar
Daniel Brown committed
634
                    elif len(v) == 2:
635
                        self.retrace = v[1]                        
636
                elif(first == "deriv_h"):
637
                    v = line.split()
638
                    if len(v) != 2:
639
                        raise pkex.BasePyKatException("deriv_h command `{0}` is incorrect.".format(line))
640
641
                    else:
                        self.deriv_h = float(v[1])
642
643
644
                elif(first == "gnuterm" or first == "pyterm"):
                    if self.verbose:
                        print "Ignoring Gnuplot/Python terminal command '{0}'".format(line)
645
646
647
648
649
                #elif(first == "fsig"):
                #    after_process.append(line)
                elif(first == "noplot"):
                    obj = line
                    self.__blocks[self.__currentTag].contents.append(line) 
Daniel Brown's avatar
Daniel Brown committed
650
651
652
                else:
                    if self.verbose:
                        print "Parsing `{0}` into pykat object not implemented yet, added as extra line.".format(line)
653
                        
Daniel Brown's avatar
Daniel Brown committed
654
655
656
657
658
                    obj = line
                    # manually add the line to the block contents
                    self.__blocks[self.__currentTag].contents.append(line) 
                
                if obj != None and not isinstance(obj, str):
659
660
661
662
                    if self.hasNamedObject(obj.name):
                        getattr(self, obj.name).remove()
                        print "Removed existing object '{0}' of type {1} to add new object".format(obj.name, obj.__class__)
                        
Daniel Brown's avatar
Daniel Brown committed
663
664
                    self.add(obj)
                    
665
                    
Daniel Brown's avatar
Daniel Brown committed
666
667
668
        # 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:
669
            first = line.split(" ",1)[0]            
Daniel Brown's avatar
Daniel Brown committed
670
            if first == "gauss" or first == "gauss*" or first == "gauss**":
671
                pykat.commands.gauss.parseFinesseText(line, self)
672
            elif (first == "scale"):
673
                v = line.split()
674
675
676
677
678
                if len(v) == 3:
                    component_name = v[2]
                    if component_name in self.__detectors :
                        self.__detectors[component_name].scale = SIfloat(v[1])
                    else:
679
                        raise pkex.BasePyKatException("scale command `{0}` refers to non-existing output".format(component_name))
680
681
682
                elif len(values) == 2:
                    self.scale = SIfloat(v[1])
                else:
683
                    raise pkex.BasePyKatException("scale command `{0}` is incorrect.".format(line))
684
            elif (first == "pdtype"):
685
                v = line.split()
686
687
688
                if len(v) == 3:
                    component_name = v[1]
                    if component_name in self.__detectors :
Andreas Freise's avatar
Andreas Freise committed
689
                        self.__detectors[component_name].pdtype = v[2]
690
                    else:
691
                        raise pkex.BasePyKatException("pdtype command `{0}` refers to non-existing detector".format(component_name))
692
                else:
693
                    raise pkex.BasePyKatException("pdtype command `{0}` is incorrect.".format(line))
Daniel Brown's avatar
Daniel Brown committed
694
695
            elif(first == "attr"):
                v = line.split()
696

Daniel Brown's avatar
Daniel Brown committed
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
                if len(v) < 4:
                    raise pkex.BasePyKatException("attr command `{0}` is incorrect.".format(line))
                else:
                    # get the component/detector in question
                    if v[1] in self.__components:
                        comp = self.__components[v[1]]
                    elif v[1] in self.__detectors:
                        comp = self.__detectors[v[1]]
                    else:
                        raise pkex.BasePyKatException("Could not find the component '{0}' for attr command in line '{1}'".format(v[1], line))
                
                    if len(v[2:]) % 2 == 1:
                        raise pkex.BasePyKatException("Attr command '{0}' must specify both parameter and value pairs".format(line))
                                                
                    # convert split list to key value pairs
                    kv = dict(itertools.izip_longest(*[iter(v[2:])] * 2, fillvalue=None))

                    comp.parseAttributes(kv)
715
                    
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
            elif(first == "fsig"):
                
                v = line.split()
                
                if v[2] in self.__components:
                    comp = self.__components[v[1]]
                else:
                    raise pkex.BasePyKatException("Could not find the component '{0}' for attr command in line '{1}'".format(v[1], line))
                
                
                #kat.siganls.apply()
                
            else:
                raise pkex.BasePyKatException("Haven't handled parsing of '{0}'".format(line))
                    
Daniel Brown's avatar
Daniel Brown committed
731
        self.__currentTag = NO_BLOCK 
732
        
Daniel Brown's avatar
Daniel Brown committed
733
734
735
736
737
738
739
740
741
742
743
744
745
    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 pkex.BasePyKatException as ex:
            print ex
Daniel Brown's avatar
Daniel Brown committed
746

Daniel Brown's avatar
Daniel Brown committed
747
            
Daniel Brown's avatar
Daniel Brown committed
748
749
750
751
752
753
754
755
    def getProcess(self, callback, **kwargs):
        """
        """
        
        cmd = "\n".join(self.generateKatScript())
        
        return Process(target=f__lkat_process, args=(callback, cmd, kwargs))
           
756
    def run(self, printout=0, printerr=0, plot=None, save_output=False, save_kat=False,kat_name=None) :
Daniel Brown's avatar
Daniel Brown committed
757
758
759
760
        """ 
        Runs the current simulation setup that has been built thus far.
        It returns a katRun or katRun2D object which is populated with the various
        data from the simulation run.
Sean Leavey's avatar
Sean Leavey committed
761
        printout=1 prints the Finesse banner
762
        printerr shows the Finesse progress (set kat.verbose=1 to see warnings and errors)
Daniel Brown's avatar
Daniel Brown committed
763
764
765
766
767
768
769
770
771
772
773
774
        """
        start = datetime.datetime.now()
        
        try:        
            if not hasattr(self, "xaxis") and self.noxaxis != None and self.noxaxis == False:
                raise pkex.BasePyKatException("No xaxis was defined")
            
            if len(self.__katdir) == 0:
                # Get the environment variable for where Finesse is stored
                self.__finesse_dir = os.environ.get('FINESSE_DIR')
                
                if self.__finesse_dir == None :
775
                    raise pkex.MissingFinesseEnvVar()
Daniel Brown's avatar
Daniel Brown committed
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
            else:
                self.__finesse_dir = self.__katdir
                
            if len(self.__katname) == 0:
                katexe = "kat"
                
                if os.sys.platform == "win32":
                    katexe += ".exe"
            else:
                katexe = self.__katname
            
            kat_exec = os.path.join(self.__finesse_dir, katexe) 
            
            # 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)):
791
                raise pkex.MissingFinesse()
Daniel Brown's avatar
Daniel Brown committed
792
793
794
795
796
797
798
799
800
                
            if self.verbose: print "--------------------------------------------------------------"
            if self.verbose: print "Running kat - Started at " + str(start)
            
            if hasattr(self, "x2axis"):
                r = katRun2D()
            else:
                r = katRun()
                
801
            r.yaxis = self.yaxis
Daniel Brown's avatar
Daniel Brown committed
802
            r.katScript = "".join(self.generateKatScript())   
803
804
805
806
807
808
809
810

            if (plot==None):
                # ensure we don't do any plotting. That should be handled
                # by user themselves
                r.katScript+=("gnuterm no\n")
                r.katScript+=("pyterm no\n")
            else:
                r.katScript+=(plot+"\n")
Daniel Brown's avatar
Daniel Brown committed
811
812
813
814
815
816
817
818
819
820
            
            # create a kat file which we will write the script into
            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' ) 
                
            katfile.writelines(r.katScript)
            katfile.flush()
821

822
            if printout == 1 or plot != None:
823
824
825
                cmd=[kat_exec]
            else:
                cmd=[kat_exec, '--perl1']
Daniel Brown's avatar
Daniel Brown committed
826
827
828
829
830
831
832
833
834
835
            
            if self.__time_code:
                cmd.append('--perf-timing')

            cmd.append('--no-backspace')
            # set default format so that less repeated numbers are printed to the
            # output file, should speed up running and parsing of output files
            cmd.append('-format=%.15g')

            cmd.append(katfile.name)
836
                            
Daniel Brown's avatar
Daniel Brown committed
837
838
839
            p=subprocess.Popen(cmd, shell=False, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
            err = ""
            
Andreas Freise's avatar
Andreas Freise committed
840
            #if self.verbose: print "Finesse output:"
841

Daniel Brown's avatar
Daniel Brown committed
842
843
            for line in iter(p.stderr.readline, ""):
                
844
                if len(line) > 0:
Daniel Brown's avatar
Daniel Brown committed
845
846
                    
                    if line.rstrip().endswith('s'):
Daniel Brown's avatar
Daniel Brown committed
847
848
                        vals = line.split("-")
                        action = vals[0].strip()
Daniel Brown's avatar
Daniel Brown committed
849
850
                        prc = vals[1].strip()[:]
                        
851
                        if printerr == 1:
Daniel Brown's avatar
Daniel Brown committed
852
853
854
855
856
857
858
859
860
                            sys.stdout.write("\r{0} {1}".format(action, prc))
                    elif line.rstrip().endswith('%'):
                        vals = line.split("-")
                        action = vals[0].strip()
                        prc = vals[1].strip()[:]
                        
                        if printerr == 1:
                            sys.stdout.write("\r{0} {1}".format(action, prc))
                            
861
862
                    elif line[0:3] == '** ':
                        if self.verbose: sys.stdout.write(line)
863
864
                    else:
                        err += line
865

Daniel Brown's avatar
Daniel Brown committed
866
            
Daniel Brown's avatar
Daniel Brown committed
867
            [out,errpipe] = p.communicate()
868
869
            if printout == 1: 
                print out
Andreas Freise's avatar
Andreas Freise committed
870
871
            else:
                if printerr == 1: print ""
872

Daniel Brown's avatar
Daniel Brown committed
873
874
875
876
877
878
            # get the version number
            ix = out.find('build ') + 6
            ix2 = out.find(')',ix)
            r.katVersion = out[ix:ix2]
            
            r.runDateTime = datetime.datetime.now()
879
880

            # If Finesse returned an error, just print that and exit!
Daniel Brown's avatar
Daniel Brown committed
881
            if p.returncode != 0:
882
883
                print err
                sys.exit(1) 
Daniel Brown's avatar
Daniel Brown committed
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
            
            root = os.path.splitext(katfile.name)
            base = os.path.basename(root[0])            
            outfile = root[0] + ".out"
            
            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)

                if self.verbose: print "\nOutput data saved to '{0}'".format(newoutfile)
            
            if hasattr(self, "x2axis"):
                [r.x,r.y,r.z,hdr] = self.readOutFile(outfile)
                
                r.xlabel = hdr[0]
                r.ylabel = hdr[1]
                r.zlabels = map(str.strip, hdr[2:])
            else:
                [r.x,r.y,hdr] = self.readOutFile(outfile)
            
                r.xlabel = hdr[0]
                r.ylabels = map(str.strip, hdr[1:])
                            
            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)         
                
                if self.verbose: print "Kat file saved to '{0}'".format(newkatfile)
                
Sean Leavey's avatar
Sean Leavey committed
928
929
930
931
932
933
934
935
            if self.trace != None and self.trace > 0:
                #print "{0}".format(out)
                #if self.trace & 1:
                    #search = out.find(' --- highest order of TEM modes')
                    #if search > -1:
                        #print "Trace 1: {0}".format(out[search:])

                # for now, just try to print the trace block in full
Sean Leavey's avatar
Bug fix    
Sean Leavey committed
936
                print out[out.find(' ---') :]
Daniel Brown's avatar
Daniel Brown committed
937
938
939
940
941
942
943
944

            katfile.close()
            perfData = []
            
            if self.__time_code:
                perffile = open(root[0] + ".perf",'r')
                
                for l in perffile.readlines():
945
                    vals = l.strip().split()
Daniel Brown's avatar
Daniel Brown committed
946
947
948
949
950
                    perfData.append((vals[0], float(vals[1]), float(vals[2]), float(vals[3])))
                    
                return [r, perfData]
            else:
                return r
951
952
            
        except pkex.FinesseRunError as fe:
Daniel Brown's avatar
Daniel Brown committed
953
954
955
956
957
            print fe
        finally:
            if self.verbose: print ""
            if self.verbose: print "Finished in " + str(datetime.datetime.now()-start)
            
958
959
960
961
962
963
    def remove(self, obj):
        if not (obj.name in self.__components or obj.name in self.__detectors or obj.name in self.__commands):
            raise pkex.BasePyKatException("{0} is not currently in the simulation".format(obj.name))
        
        if obj.removed:
            raise pkex.BasePyKatException("{0} has already been removed".format(obj.name))        
Daniel Brown's avatar
Daniel Brown committed
964
965

        nodes = None
966
        
Daniel Brown's avatar
Daniel Brown committed
967
968
969
970
        # store nodes that this componet is attached to as a reference for gui
        if isinstance(obj, Component):
            nodes = self.nodes.getComponentNodes(obj)

971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
        if isinstance(obj, Component):    
            del self.__components[obj.name]
            self.__del_component(obj)
            self.nodes.removeComponent(obj)
        elif isinstance(obj, Command):    
            del self.__commands[obj.name]
            self.__del_command(obj)
        elif isinstance(obj, Detector):    
            del self.__detectors[obj.name]
            self.__del_detector(obj)
        
        for b in self.__blocks:
            if obj in self.__blocks[b].contents:
                self.__blocks[b].contents.remove(obj)
        
Daniel Brown's avatar
Daniel Brown committed
986
987
988
989
990
        if self.pykatgui != None:
            self.pykatgui._onComponentRemoved(obj, nodes)
    
        del nodes
        
991
992
        import gc
        print gc.get_referrers(obj)
993
994
995
    
    def hasNamedObject(self, name):
        return name in self.__components or name in self.__detectors or name in self.__commands
Daniel Brown's avatar
Daniel Brown committed
996
997
998
999
1000
        
    def add(self, obj):
        try:
            obj.tag = self.__currentTag
            self.__blocks[self.__currentTag].contents.append(obj)