finesse.py 59.5 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
# -*- 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
35
36
import re
import math       
Daniel Brown's avatar
Daniel Brown committed
37
import itertools
Daniel Brown's avatar
Daniel Brown committed
38
import ctypes
Daniel Brown's avatar
Daniel Brown committed
39
import ctypes.util
Daniel Brown's avatar
Daniel Brown committed
40
import collections
41
import re
42
import copy
43

44
from collections import namedtuple, OrderedDict
45

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

import pykat.exceptions as pkex

55
from pykat import USE_GUI, NoGUIException
56
57
58
59
60

if USE_GUI:
    from pykat.gui.gui import pyKatGUI
    from PyQt4.QtCore import QCoreApplication
    from PyQt4.QtGui import QApplication
Daniel Brown's avatar
Daniel Brown committed
61

Daniel Brown's avatar
Daniel Brown committed
62
63
from multiprocessing import Process, Manager

Daniel Brown's avatar
Daniel Brown committed
64
NO_BLOCK = "NO_BLOCK"
65
66
pykat_web = "www.gwoptics.org/pykat"

Daniel Brown's avatar
Daniel Brown committed
67
68
69
70
71
72
73
# 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
74
75
76
def f__lkat_process(callback, cmd, kwargs):
    """
    """
Daniel Brown's avatar
Daniel Brown committed
77
78
79
80
81
    
    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
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: 
95
        print "Exception caught in python: ", ex.message
Daniel Brown's avatar
Daniel Brown committed
96
97
98
    finally:
        # This should always be called no matter what
        lkat._pykat_finish(0)
Daniel Brown's avatar
Daniel Brown committed
99
100


101
def f__lkat_trace_callback(lkat, trace_info, getCavities, getNodes, getSpaces):
Daniel Brown's avatar
Daniel Brown committed
102
103
104
105
106
107
108
109
110
111
112
113
    """
    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()

114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
    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
141
142
                                )

143
            trace_info[cav.name] = cav_info
Daniel Brown's avatar
Daniel Brown committed
144

145
146
147
    if getSpaces:
        for s in range(0, inter.num_spaces):
            space = inter.space_list[s]
Daniel Brown's avatar
Daniel Brown committed
148

149
150
            trace_info[space.name] = space_trace(gouyx = space.gouy_x,
                                                 gouyy = space.gouy_y)
Daniel Brown's avatar
Daniel Brown committed
151
                     
152
                                             
Daniel Brown's avatar
Daniel Brown committed
153
154
class katRun(object):
    def __init__(self):
155
        self.runDateTime = datetime.datetime.now()
Daniel Brown's avatar
Daniel Brown committed
156
157
158
159
160
161
        self.x = None
        self.y = None
        self.xlabel = None
        self.ylabels = None
        self.katScript = None
        self.katVersion = None
162
        self.yaxis = None
163
        
164
    def plot(self):
165
166
167
        import pylab
        
        pylab.plot(self.x, self.y)
168
        pylab.legend(self.ylabels,0)
169
170
        pylab.xlabel(self.xlabel)
        pylab.show()
Daniel Brown's avatar
Daniel Brown committed
171
        
172
    def savekatRun(self, filename):
Daniel Brown's avatar
Daniel Brown committed
173
174
175
176
177
178
179
180
181
182
183
        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):
184
        idx = [i for i in range(len(self.ylabels)) if self.ylabels[i].split()[0] == str(value)]
185

186
        if len(idx) > 0:
187
188
            out = self.y[:, idx]
            
189
190
191
192
193
194
195
            if len(idx) == 1:
                if self.yaxis == "abs:deg":
                    out = self.y[:, idx[0]]
                elif self.yaxis == "re:im":
                    out = self.y[:, idx[0]]
            else: 
                if self.yaxis == "abs:deg":
196
                    out = self.y[:, idx[0]] * np.exp(1j*math.pi*self.y[:, idx[1]]/180.0)
197
198
                elif self.yaxis == "re:im":
                    out = self.y[:, idx[0]] + 1j*self.y[:, idx[1]]
199
            
200
            if out.size == 1:
201
                return out[0].squeeze()
202
            else:
203
                return out.squeeze()
Daniel Brown's avatar
Daniel Brown committed
204
        else:
205
            raise  pkex.BasePyKatException("No output by the name '{0}' found in the output".format(str(value)))
Daniel Brown's avatar
Daniel Brown committed
206
207
208
      
class katRun2D(object):
    def __init__(self):
209
        self.runDateTime = datetime.datetime.now()
Daniel Brown's avatar
Daniel Brown committed
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
        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)
    
228
    def get(self, value): return self[value].squeeze()
Daniel Brown's avatar
Daniel Brown committed
229
230
    
    def __getitem__(self, value):
231
        idx = [i for i in range(len(self.zlabels)) if self.zlabels[i].split()[0] == str(value)]
Daniel Brown's avatar
Daniel Brown committed
232
233
234
235
236
        
        if len(idx) > 0:
            return self.z[idx].squeeze()
        else:
            raise  pkex.BasePyKatException("No output by the name {0} found".format(str(value)))
237
    
238
        
239
240
class Signals(object):
    class fsig(object):
Daniel Brown's avatar
Daniel Brown committed
241
        def __init__(self, param, name, amplitude, phase, signal):
242
243
244
245
246
            self._params = []
            self.__target = param
            self.__name = name
            self.__amplitude = Param("amp", self, SIfloat(amplitude))
            self.__phase = Param("phase", self, SIfloat(phase))
247
            self.__removed = False
Daniel Brown's avatar
Daniel Brown committed
248
249
            self.__signal = signal
			
250
            # unfortunatenly the target names for fsig are not the same as the
Daniel Brown's avatar
Daniel Brown committed
251
            # various parameter names of the components, e.g. mirror xbeta is x 
252
253
254
            # 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:
255
                raise  pkex.BasePyKatException("Cannot fsig parameter {1} on component {0}".format(str(param._owner().name), param.name))
256
257
258
            
        def _register_param(self, param):
            self._params.append(param)
259
260
261
        
        @property
        def removed(self): return self.__removed
262
  
263
        def remove(self):
264
265
266
            self.__signal._kat.remove(self)
            
        def _on_remove(self):
267
268
269
            if self.__removed:
                raise pkex.BasePyKatException("Signal {0} has already been marked as removed".format(self.name))
            else:
Daniel Brown's avatar
Daniel Brown committed
270
271
                self.__signal.targets.remove(self)
                self.__remove = True
272
        
273
274
275
276
277
        @property
        def name(self): return self.__name

        @property
        def amplitude(self): return self.__amplitude
278
279
280
        @amplitude.setter
        def amplitude(self,value): self.__amplitude.value = SIfloat(value)

281
282
283

        @property
        def phase(self): return self.__phase
284
285
        @phase.setter
        def phase(self,value): self.__phase.value = SIfloat(value)
286
287
288
289
290

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

        @property
291
        def owner(self): return self.__target._owner().name
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
    
        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:
308
            return "fsignal"
309
310
        else:
            return self.targets[0].name
311
312
            
    @property
Daniel Brown's avatar
Daniel Brown committed
313
    def removed(self): return False # we can never remove the Signal object altogethr just the individual fsig targets
314

315
316
    def remove(self):
        for t in self.targets:
Daniel Brown's avatar
Daniel Brown committed
317
            t.remove()
318
319
320
        
        del self.targets[:]
        
321
322
    @property
    def f(self): return self.__f
323
324
    @f.setter
    def f(self,value): self.__f.value = SIfloat(value)
325
    
Daniel Brown's avatar
Daniel Brown committed
326
    def __init__(self, kat):
327
328
329
        self.targets = []
        self._params = []
        self.__f = Param("f", self, 1)
330
331
        self._kat = kat
        
332
333
334
335
336
337
338
339
340
    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:
341
            name = "sig_" + target._owner().name + "_" + target.name
342
        
Daniel Brown's avatar
Daniel Brown committed
343
        self.targets.append(Signals.fsig(target, name, amplitude, phase, self))
344
345
346
347
348
349
        
    def getFinesseText(self):
        rtn = []
        
        for t in self.targets:
            rtn.extend(t.getFinesseText())
Daniel Brown's avatar
Daniel Brown committed
350
351
352
353
354
355
356
357
358
            
            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 if t.amplitude != None else "")))

359
360
361
362
363
        for p in self._params:
            rtn.extend(p.getFinesseText())
        
        return rtn
        
Daniel Brown's avatar
Daniel Brown committed
364
365
366
367
368
369
370
371
372
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
    
373
374
375
Constant = namedtuple('Constant', 'name, value, usedBy')
    
class kat(object):  
Daniel Brown's avatar
Daniel Brown committed
376
377
        
    def __init__(self, kat_file=None, kat_code=None, katdir="", katname="", tempdir=None, tempname=None):
378
379
380

        cls = type(self)
        self.__class__ = type(cls.__name__, (cls,), {})
Daniel Brown's avatar
Daniel Brown committed
381
382
383
        
        self.scene = None # scene object for GUI
        self.verbose = True
384
        self.__blocks = OrderedDict() # dictionary of blocks that are used
Daniel Brown's avatar
Daniel Brown committed
385
386
387
388
389
390
391
392
393
394
        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
Daniel Brown's avatar
Daniel Brown committed
395
        self.__signals = Signals(self)
396
        self.constants = {}
397
        self.vacuum = []
398
399
        self.__prevrunfilename = None
        self.printmatrix = None
400
401
402
403
        
        # initialise default block
        self.__currentTag= NO_BLOCK
        self.__blocks[NO_BLOCK] = Block(NO_BLOCK)
Daniel Brown's avatar
Daniel Brown committed
404
405
406
        
        # Various options for running finesse, typicaly the commands with just 1 input
        # and have no name attached to them.
407
408
        self.retrace = None
        self.deriv_h = None
409
        self.scale = None
Sean Leavey's avatar
Sean Leavey committed
410
        self.__trace = None
Daniel Brown's avatar
Daniel Brown committed
411
412
        self.__phase = None
        self.__maxtem = None
413
        self.__noxaxis = False
Daniel Brown's avatar
Daniel Brown committed
414
        self.__time_code = None
415
        self.__yaxis = "abs" # default yaxis
416
        self.__lambda0 = 1064e-9
Daniel Brown's avatar
Daniel Brown committed
417
418
419
420
421
422
423
424
425
        
        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)
426

427
428
429
    @property
    def signals(self): return self.__signals

430
431
432
433
434
435
436
437
438
439
440
    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
441
442
443
444
445
446
447
448
449
450
451
    @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

452
453
454
455
456
457
458
459
460
461
    @property
    def lambda0(self): return self.__lambda0
    @lambda0.setter
    def lambda0(self, value):
        self.__lambda0 = SIfloat(value)
        
        for node in self.nodes.getNodes():
            if self.nodes[node].q != None:
                self.nodes[node].q.wavelength = self.__lambda0

Daniel Brown's avatar
Daniel Brown committed
462
463
464
    @property
    def maxtem(self): return self.__maxtem
    @maxtem.setter
465
466
467
468
469
    def maxtem(self,value):
        if value == "off":
            self.__maxtem = -1
        else:
            self.__maxtem = int(value)
Daniel Brown's avatar
Daniel Brown committed
470
471
472
473
474
    
    @property
    def phase(self): return self.__phase
    @phase.setter
    def phase(self,value): self.__phase = int(value)
475
        
Daniel Brown's avatar
Daniel Brown committed
476
    @property
477
478
479
    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
480
    
Daniel Brown's avatar
Daniel Brown committed
481
482
483
484
485
486
487
488
    @property
    def components(self):
        return self.__components.copy()
    
    @property
    def detectors(self):
        return self.__detectors.copy()
        
Daniel Brown's avatar
Daniel Brown committed
489
490
491
    @property
    def noxaxis(self): return self.__noxaxis
    @noxaxis.setter
492
    def noxaxis(self,value): self.__noxaxis = bool(value) 
Daniel Brown's avatar
Daniel Brown committed
493

494
495
    @staticmethod
    def logo():
496
        print """                                              ..-
497
    PyKat {0:7}         _                  '(
Daniel Brown's avatar
Daniel Brown committed
498
499
500
501
502
503
                          \\`.|\\.__...-\"\"""-_." )
       ..+-----.._        /  ' `            .-'
   . '            `:      7/* _/._\\    \\   (
  (        '::;;+;;:      `-"' =" /,`"" `) /
  L.        \\`:::a:f            c_/     n_'
  ..`--...___`.  .    ,  
504
   `^-....____:   +.      {1}\n""".format(pykat.__version__, pykat_web)
Daniel Brown's avatar
Daniel Brown committed
505
    
506
    def loadKatFile(self, katfile, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
507
        commands=open(katfile).read()
508
        self.parseCommands(commands, blocks=blocks)
Daniel Brown's avatar
Daniel Brown committed
509
    
510
    def parseKatCode(self, code, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
511
        #commands = code.split("\n")
512
        self.parseCommands(code, blocks=blocks)
513
514
515
516
517
518
519
520
521

    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:
522
            values = line.split()
523
524
525
            
            if len(values)>0 and values[0] == 'const':
                
Daniel Brown's avatar
Daniel Brown committed
526
                if len(values) >= 3:
527
528
529
                    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
530
                        constants[str(values[1])] = Constant(values[1], values[2], [])
531
532
533
534
535
536
                else:
                    raise pkex.BasePyKatException('const command "{0}" was not the correct format'.format(line))
        
        commands_new = []
        
        for line in commands:
537
            values = line.split()
538
            
539
            if len(values) > 0 and values[0] != 'const':
540
541
542
                # check if we have a var/constant in this line
                if line.find('$') >= 0:
                    for key in constants.keys():
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
                        # TODO: need to fix this for checking mulitple instances of const in a single line
                        
                        chars = [' ', '+', '-', '*', '/', ')']

                        for c in chars:
                            none_found = False
                            
                            while not none_found:
                                if line.find('$'+key+c) > -1:
                                    constants[key].usedBy.append(line)
                                    line = line.replace('$'+key+c, str(constants[key].value)+ c)
                                else:
                                    none_found = True
                        
                        if line.endswith('$'+key):
558
559
560
561
562
563
564
565
                            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
566
        
567
    def parseCommands(self, commands, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
568
569
570
        blockComment = False
        
        commands=self.remove_comments(commands)
571
572
        
        commands=self.processConstants(commands)
Daniel Brown's avatar
Daniel Brown committed
573
574
575
576
        
        after_process = [] # list of commands that should be processed after 
                           # objects have been set and created
        
577
        for line in commands:
578
579
580
581
582
583
584
585
586
587
            try:
                if len(line.strip()) >= 2:
                    line = line.strip()

                    # Looking for block start or end
                    values = line.split()
                
                    if values[0] == "%%%":
                        if values[1] == "FTblock":
                            newTag = values[2]
Daniel Brown's avatar
Daniel Brown committed
588
                        
589
590
                            if self.__currentTag != None and self.__currentTag != NO_BLOCK: 
                                warnings.warn("found block {0} before block {1} ended".format(newTag, self.__currentTag))    
Daniel Brown's avatar
Daniel Brown committed
591
                            
592
593
                            if newTag in self.__blocks:
                                raise pkex.BasePyKatException("Block `{0}` has already been read".format(newTag))
Daniel Brown's avatar
Daniel Brown committed
594
                            
595
596
                            self.__blocks[newTag] = Block(newTag) # create new list to store all references to components in block
                            self.__currentTag = newTag
Daniel Brown's avatar
Daniel Brown committed
597
                        
598
599
                        if values[1] == "FTend":
                            self.__currentTag = NO_BLOCK
Daniel Brown's avatar
Daniel Brown committed
600
                        
601
                        continue
Daniel Brown's avatar
Daniel Brown committed
602

603
604
605
606
607
608
609
                    # only include listed blocks, if we have specfied them
                    if blocks != None and self.__currentTag not in blocks:
                        continue
                    
                    # don't read comment lines
                    if line[0] == "#" or line[0] == "%":
                        continue
Daniel Brown's avatar
Daniel Brown committed
610
                
611
612
613
614
615
616
617
                    # 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
Daniel Brown's avatar
Daniel Brown committed
618
                
619
620
                    first = line.split(" ",1)[0]
                    obj = None
621
                    
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
                    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 == "sq"):
                        obj = pykat.components.squeezer.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)
                    elif(first[0:2] == "ad"):
                        obj = pykat.detectors.ad.parseFinesseText(line)
                    elif(first[0:2] == "bp"):
                        obj = pykat.detectors.bp.parseFinesseText(line)
                    elif(first[0:4] == "gouy"):
                        obj = pykat.detectors.gouy.parseFinesseText(line)
                    elif(first[0:2] == "pd" and first != "pdtype"):
                        obj = pykat.detectors.pd.parseFinesseText(line)
                    elif(first == "qshot" or first == "qshotS" or first == "qshotN"):
                        obj = pykat.detectors.qshot.parseFinesseText(line)
                    elif(first == "qnoised" or first == "qnoisedS" or first == "qnoisedN"):
                        obj = pykat.detectors.qnoised.parseFinesseText(line)
                    elif(first == "xaxis" or first == "xaxis*"):
                        obj = pykat.commands.xaxis.parseFinesseText(line)
654
655
                    elif(first[0:2] == "hd"):
                        obj = pykat.detectors.hd.parseFinesseText(line)
656
657
                    elif(first.startswith("qhd")):
                        obj = pykat.detectors.qhd.parseFinesseText(line)
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
                    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)
                    elif(first == "scale"):
                        after_process.append(line)
                    elif(first == "pdtype"):
                        after_process.append(line)
                    elif(first == "attr"):
                        after_process.append(line)
                    elif(first == "noxaxis"):
                        self.noxaxis = True
                    elif(first == "lambda"):
                        v = line.split()
                        self.lambda0 = SIfloat(v[-1])
                    elif(first == "yaxis"):
                        v = line.split()
                    
                        self.yaxis = v[-1]
                    elif(first == "phase"):
                        v = line.split()
                        if len(v) != 2:
                            raise pkex.BasePyKatException("phase command `{0}` is incorrect.".format(line))
                        else:
                            self.phase = int(v[1])
                    elif(first == "maxtem"):
                        v = line.split()
                        if len(v) != 2:
                            raise pkex.BasePyKatException("maxtem command `{0}` is incorrect.".format(line))
                        else:
                            if v[1] == "off":
                            	self.maxtem = -1
                            else:
    	                        self.maxtem = int(v[1])
                    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]
                    elif(first == "retrace"):
                        v = line.split()
                        if len(v) > 2:
                            raise pkex.BasePyKatException("Retrace command `{0}` is incorrect.".format(line))
                        elif len(v) == 2:
                            self.retrace = v[1]                        
                    elif(first == "deriv_h"):
                        v = line.split()
                        if len(v) != 2:
                            raise pkex.BasePyKatException("deriv_h command `{0}` is incorrect.".format(line))
708
                        else:
709
710
711
                            self.deriv_h = float(v[1])
                    elif(first == "gnuterm" or first == "pyterm"):
                        if self.verbose:
712
                            print "Ignoring Gnuplot/Python terminal command '{0}'".format(line)
Daniel Brown's avatar
Daniel Brown committed
713
714
                    elif(first == "fsig"):
                        after_process.append(line)
715
716
717
                    elif(first == "noplot"):
                        obj = line
                        self.__blocks[self.__currentTag].contents.append(line) 
718
                    else:
719
                        if self.verbose:
720
                            print "Parsing `{0}` into pykat object not implemented yet, added as extra line.".format(line)
721
                        
722
723
724
                        obj = line
                        # manually add the line to the block contents
                        self.__blocks[self.__currentTag].contents.append(line) 
Daniel Brown's avatar
Daniel Brown committed
725
                
726
727
728
                    if obj != None and not isinstance(obj, str):
                        if self.hasNamedObject(obj.name):
                            getattr(self, obj.name).remove()
729
                            print "Removed existing object '{0}' of type {1} to add line '{2}'".format(obj.name, obj.__class__, line)
730
                        
731
732
                        self.add(obj)
            except:
733
734
735
                print "--------------------------------------------------------"
                print "Error parsing line: " + line
                print "--------------------------------------------------------"
736
737
738
                raise
                
                
Daniel Brown's avatar
Daniel Brown committed
739
740
741
        # 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:
742
            first = line.split(" ",1)[0]            
Daniel Brown's avatar
Daniel Brown committed
743
            if first == "gauss" or first == "gauss*" or first == "gauss**":
744
                pykat.commands.gauss.parseFinesseText(line, self)
745
            elif (first == "scale"):
746
                v = line.split()
747
                accepted = ["psd","psd_hf","asd","asd_hf","meter", "ampere", "degs"]
Daniel Brown's avatar
Daniel Brown committed
748
                
749
750
                if len(v) == 3:
                    component_name = v[2]
Daniel Brown's avatar
Daniel Brown committed
751
                    
752
                    if v[1].lower() in accepted:
Daniel Brown's avatar
Daniel Brown committed
753
754
755
756
                        val = v[1]
                    else:
                        try:
                            val = SIfloat(v[1])
757
                        except ValueError as ex:
Daniel Brown's avatar
Daniel Brown committed
758
759
                            raise pkex.BasePyKatException("Line `{0}`:\nAccepted scale values are decimal numbers or %s." % (line,str(accepted)))
                            
760
                    if component_name in self.__detectors :
Daniel Brown's avatar
Daniel Brown committed
761
                        self.__detectors[component_name].scale.append(val)
762
                    else:
763
                        raise pkex.BasePyKatException("scale command `{0}` refers to non-existing output".format(component_name))
764
765
766
767
768
                elif len(v) == 2:
                    if v[1] == "meter" or v[1] == "ampere" or v[1] == "deg":
                        self.scale = v[1]
                    else:
                        self.scale = SIfloat(v[1])
769
                else:
770
                    raise pkex.BasePyKatException("scale command `{0}` is incorrect.".format(line))
771
            elif (first == "pdtype"):
772
                v = line.split()
773
774
775
                if len(v) == 3:
                    component_name = v[1]
                    if component_name in self.__detectors :
Andreas Freise's avatar
Andreas Freise committed
776
                        self.__detectors[component_name].pdtype = v[2]
777
                    else:
778
                        raise pkex.BasePyKatException("pdtype command `{0}` refers to non-existing detector".format(component_name))
779
                else:
780
                    raise pkex.BasePyKatException("pdtype command `{0}` is incorrect.".format(line))
Daniel Brown's avatar
Daniel Brown committed
781
782
            elif(first == "attr"):
                v = line.split()
783

Daniel Brown's avatar
Daniel Brown committed
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
                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)
802
                    
803
804
805
806
            elif(first == "fsig"):
                
                v = line.split()
                
Daniel Brown's avatar
Daniel Brown committed
807
808
809
810
                name = str(v[1])
                
                if v[2] not in self.__components:
                    raise pkex.BasePyKatException("Could not find the component '{0}'. Line: '{1}'".format(v[2], line))
811
                
Daniel Brown's avatar
Daniel Brown committed
812
813
814
815
816
817
818
819
820
821
                comp = self.__components[v[2]]
                
                if comp._default_fsig() == None:
                    raise pkex.BasePyKatException("Component '{0}' cannot be fsig'd. Line: '{1}'".format(comp.name, line))
                    
                param = None
                amp = None
                
                if len(v) == 5:
                    param == None
822
823
                    freq = float(v[3])
                    phase = float(v[4])
Daniel Brown's avatar
Daniel Brown committed
824
                elif len(v) == 6:
825
826
827
828
                    if v[3].isdigit():
                        freq = float(v[3])
                        phase = float(v[4])
                        amp = float(v[5])
Daniel Brown's avatar
Daniel Brown committed
829
                    else:
830
831
832
                        param = v[3]
                        freq = float(v[4])
                        phase = float(v[5])
Daniel Brown's avatar
Daniel Brown committed
833
834
                elif len(v) == 7:
                    param = v[3]
835
836
837
                    freq = float(v[4])
                    phase = float(v[5])
                    amp = float(v[6])
Daniel Brown's avatar
Daniel Brown committed
838
839
                else:
                    raise pkex.BasePyKatException("'{0}' isnot a valid fsig command".format(line))
840
                
Daniel Brown's avatar
Daniel Brown committed
841
                self.signals.apply(comp._default_fsig(), amp, phase, name)
842
843
844
845
                
            else:
                raise pkex.BasePyKatException("Haven't handled parsing of '{0}'".format(line))
                    
Daniel Brown's avatar
Daniel Brown committed
846
        self.__currentTag = NO_BLOCK 
847
        
Daniel Brown's avatar
Daniel Brown committed
848
849
850
851
852
853
854
855
856
857
858
859
    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:
860
            print ex
Daniel Brown's avatar
Daniel Brown committed
861

Daniel Brown's avatar
Daniel Brown committed
862
            
Daniel Brown's avatar
Daniel Brown committed
863
864
865
866
867
868
869
870
    def getProcess(self, callback, **kwargs):
        """
        """
        
        cmd = "\n".join(self.generateKatScript())
        
        return Process(target=f__lkat_process, args=(callback, cmd, kwargs))
           
871
    def run(self, printout=0, printerr=0, plot=None, save_output=False, save_kat=False, kat_name=None, cmd_args=None) :
Daniel Brown's avatar
Daniel Brown committed
872
873
874
875
        """ 
        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
876
        printout=1 prints the Finesse banner
877
        printerr shows the Finesse progress (set kat.verbose=1 to see warnings and errors)
878
879
880
881
882
        plot (string) - Sets gnuterm for plotting
        save_output (bool) - if true does not delete out file
        save_kat (bool) - if true does not delete kat file
        kat_name (string) - name of kat file if needed, will be randomly generated otherwise
        cmd_args (list of strings) - command line flags to pass to FINESSE
Daniel Brown's avatar
Daniel Brown committed
883
884
885
886
887
888
889
890
891
892
893
894
        """
        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 :
895
                    raise pkex.MissingFinesseEnvVar()
Daniel Brown's avatar
Daniel Brown committed
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
            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)):
911
                raise pkex.MissingFinesse()
Daniel Brown's avatar
Daniel Brown committed
912
                
913
914
            if self.verbose: print "--------------------------------------------------------------"
            if self.verbose: print "Running kat - Started at " + str(start)
Daniel Brown's avatar
Daniel Brown committed
915
            
916
            if hasattr(self, "x2axis") and self.noxaxis == False:
Daniel Brown's avatar
Daniel Brown committed
917
918
919
920
                r = katRun2D()
            else:
                r = katRun()
                
921
            r.yaxis = self.yaxis
Daniel Brown's avatar
Daniel Brown committed
922
            r.katScript = "".join(self.generateKatScript())   
923

924
925
926
927
928
929
930
            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
931
932
933
934
935
936
937
938
939
940
            
            # 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()
941

942
            if printout == 1 or plot != None:
943
944
945
                cmd=[kat_exec]
            else:
                cmd=[kat_exec, '--perl1']
Daniel Brown's avatar
Daniel Brown committed
946
947
948
            
            if self.__time_code:
                cmd.append('--perf-timing')
949
950
951
952
            
            if cmd_args != None:
                cmd.extend(cmd_args)
                
Daniel Brown's avatar
Daniel Brown committed
953
954
955
956
957
958
            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)
959
                            
Daniel Brown's avatar
Daniel Brown committed
960
961
962
            p=subprocess.Popen(cmd, shell=False, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
            err = ""
            
963
            #if self.verbose: print "Finesse output:"            
Daniel Brown's avatar
Daniel Brown committed
964
            for line in iter(p.stderr.readline, ""):
965
                if len(line) > 0:
966
967
968
                    # remove any ANSI commands
                    ansi = re.compile(r'\x1b[^m]*m')
                    line = ansi.sub('', line)
969

970
971
                    # warnings and errors start with an asterisk 
                    # so if verbose show them
972
973
974
                    if line.lstrip().startswith('*PROG*'):
                        line = line[8:-1]
                        vals = line.split("-",1)
975
976
977
978
979
                        action = vals[0].strip()
                        prc = vals[1].strip()[:]
                    
                        if printerr == 1:
                            sys.stdout.write("\r{0} {1}".format(action, prc))
980
981
                    elif line.lstrip().startswith('*'):
                        if self.verbose: sys.stdout.write(line)        
Daniel Brown's avatar
Daniel Brown committed
982
983
984
985
986
987
988
                    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))
989
                            
990
991
                    else:
                        err += line
992

Daniel Brown's avatar
Daniel Brown committed
993
            
Daniel Brown's avatar
Daniel Brown committed
994
            [out,errpipe] = p.communicate()
995
            
996
            if printout == 1: 
997
                print out
Andreas Freise's avatar
Andreas Freise committed
998
            else:
999
                if printerr == 1: print ""
1000