finesse.py 54.4 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
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
from collections import namedtuple, OrderedDict
42

Daniel Brown's avatar
Daniel Brown committed
43
44
45
46
47
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
48
from pykat.SIfloat import *
49
from pykat.param import Param, AttrParam
Daniel Brown's avatar
Daniel Brown committed
50
51
52
53
54
55

import pykat.exceptions as pkex

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

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

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

Daniel Brown's avatar
Daniel Brown committed
62
63
64
65
66
67
68
# 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
69
70
71
def f__lkat_process(callback, cmd, kwargs):
    """
    """
Daniel Brown's avatar
Daniel Brown committed
72
73
74
75
76
    
    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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

    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
94
95


96
def f__lkat_trace_callback(lkat, trace_info, getCavities, getNodes, getSpaces):
Daniel Brown's avatar
Daniel Brown committed
97
98
99
100
101
102
103
104
105
106
107
108
    """
    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()

109
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
    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
136
137
                                )

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

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

144
145
            trace_info[space.name] = space_trace(gouyx = space.gouy_x,
                                                 gouyy = space.gouy_y)
Daniel Brown's avatar
Daniel Brown committed
146
147
                     
                                             
Daniel Brown's avatar
Daniel Brown committed
148
149
150
151
152
153
154
155
156
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
157
        self.yaxis = None
158
        
159
160
161
162
163
164
165
    def plot(self):
        import pylab
        
        pylab.plot(self.x, self.y)
        pylab.legend(self.ylabels,0)
        pylab.xlabel(self.xlabel)
        pylab.show()
Daniel Brown's avatar
Daniel Brown committed
166
        
167
    def savekatRun(self, filename):
Daniel Brown's avatar
Daniel Brown committed
168
169
170
171
172
173
174
175
176
177
178
        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):
179
        idx = [i for i in range(len(self.ylabels)) if self.ylabels[i].split()[0] == str(value)]
Daniel Brown's avatar
Daniel Brown committed
180
        
181
182
183
        
        if len(idx) > 0:
            out = self.y[:, idx]
184
            
185
186
187
188
189
190
191
            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()
            
192
            if out.size == 1:
193
                return out[0]
194
            else:
195
                return out
Daniel Brown's avatar
Daniel Brown committed
196
        else:
197
            raise  pkex.BasePyKatException("No output by the name '{0}' found in the output".format(str(value)))
Daniel Brown's avatar
Daniel Brown committed
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
      
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)
    
220
    def get(self, value): return self[value].squeeze()
Daniel Brown's avatar
Daniel Brown committed
221
222
    
    def __getitem__(self, value):
223
        idx = [i for i in range(len(self.zlabels)) if self.zlabels[i].split()[0] == str(value)]
Daniel Brown's avatar
Daniel Brown committed
224
225
226
227
228
        
        if len(idx) > 0:
            return self.z[idx].squeeze()
        else:
            raise  pkex.BasePyKatException("No output by the name {0} found".format(str(value)))
229
    
230
        
231
232
class Signals(object):
    class fsig(object):
233
234
235
236
237
238
        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))
239
            self.__removed = False
240
241
242
243
244
245
            
            # 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:
246
                raise  pkex.BasePyKatException("Cannot fsig parameter {1} on component {0}".format(str(param._owner().name), param.name))
247
248
249
            
        def _register_param(self, param):
            self._params.append(param)
250
251
252
        
        @property
        def removed(self): return self.__removed
253
  
254
255
256
257
258
259
        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)
        
260
261
262
263
264
        @property
        def name(self): return self.__name

        @property
        def amplitude(self): return self.__amplitude
265
266
267
        @amplitude.setter
        def amplitude(self,value): self.__amplitude.value = SIfloat(value)

268
269
270

        @property
        def phase(self): return self.__phase
271
272
        @phase.setter
        def phase(self,value): self.__phase.value = SIfloat(value)
273
274
275
276
277

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

        @property
278
        def owner(self): return self.__target._owner().name
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
    
        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:
295
            return "fsignal"
296
297
        else:
            return self.targets[0].name
298
299
300
301
            
    @property
    def removed(self): return False # we can never remove the Signal object altogethr just the
                                    # individual fsig targets
302

303
304
305
306
    def remove(self):
        for t in self.targets:
            self._kat.remove(self)
            
307
308
    @property
    def f(self): return self.__f
309
310
    @f.setter
    def f(self,value): self.__f.value = SIfloat(value)
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
    
    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:
328
            name = "sig_" + target._owner().name + "_" + target.name
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
        
        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
345
346
347
348
349
350
351
352
353
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
    
354
355
356
Constant = namedtuple('Constant', 'name, value, usedBy')
    
class kat(object):  
Daniel Brown's avatar
Daniel Brown committed
357
358
        
    def __init__(self, kat_file=None, kat_code=None, katdir="", katname="", tempdir=None, tempname=None):
359
360
361

        cls = type(self)
        self.__class__ = type(cls.__name__, (cls,), {})
Daniel Brown's avatar
Daniel Brown committed
362
363
364
        
        self.scene = None # scene object for GUI
        self.verbose = True
365
        self.__blocks = OrderedDict() # dictionary of blocks that are used
Daniel Brown's avatar
Daniel Brown committed
366
367
368
369
370
371
372
373
374
375
        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
376
        self.__signals = Signals()
377
        self.constants = {}
378
        self.vacuum = []
379
380
        self.__prevrunfilename = None
        self.printmatrix = None
381
382
383
384
        
        # initialise default block
        self.__currentTag= NO_BLOCK
        self.__blocks[NO_BLOCK] = Block(NO_BLOCK)
Daniel Brown's avatar
Daniel Brown committed
385
386
387
        
        # Various options for running finesse, typicaly the commands with just 1 input
        # and have no name attached to them.
388
389
        self.retrace = None
        self.deriv_h = None
390
        self.scale = None
Sean Leavey's avatar
Sean Leavey committed
391
        self.__trace = None
Daniel Brown's avatar
Daniel Brown committed
392
393
        self.__phase = None
        self.__maxtem = None
394
        self.__noxaxis = False
Daniel Brown's avatar
Daniel Brown committed
395
        self.__time_code = None
396
        self.__yaxis = "abs" # default yaxis
397
        self.__lambda0 = 1064e-9
Daniel Brown's avatar
Daniel Brown committed
398
399
400
401
402
403
404
405
406
        
        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)
Daniel Brown's avatar
Daniel Brown committed
407

408
409
410
    @property
    def signals(self): return self.__signals

411
412
413
414
415
416
417
418
419
420
421
    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
422
423
424
425
426
427
428
429
430
431
432
    @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

433
434
435
436
437
438
439
440
441
442
    @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
443
444
445
    @property
    def maxtem(self): return self.__maxtem
    @maxtem.setter
446
447
448
449
450
    def maxtem(self,value):
        if value == "off":
            self.__maxtem = -1
        else:
            self.__maxtem = int(value)
Daniel Brown's avatar
Daniel Brown committed
451
452
453
454
455
    
    @property
    def phase(self): return self.__phase
    @phase.setter
    def phase(self,value): self.__phase = int(value)
456
        
Daniel Brown's avatar
Daniel Brown committed
457
458
459
460
461
    @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
462
463
464
465
466
467
468
469
    @property
    def components(self):
        return self.__components.copy()
    
    @property
    def detectors(self):
        return self.__detectors.copy()
        
Daniel Brown's avatar
Daniel Brown committed
470
471
472
    @property
    def noxaxis(self): return self.__noxaxis
    @noxaxis.setter
473
    def noxaxis(self,value): self.__noxaxis = bool(value) 
Daniel Brown's avatar
Daniel Brown committed
474

475
476
    @staticmethod
    def logo():
Daniel Brown's avatar
Daniel Brown committed
477
        print """                                              ..-
478
    PyKat {0:7}         _                  '(
Daniel Brown's avatar
Daniel Brown committed
479
480
481
482
483
484
                          \\`.|\\.__...-\"\"""-_." )
       ..+-----.._        /  ' `            .-'
   . '            `:      7/* _/._\\    \\   (
  (        '::;;+;;:      `-"' =" /,`"" `) /
  L.        \\`:::a:f            c_/     n_'
  ..`--...___`.  .    ,  
Daniel Brown's avatar
Daniel Brown committed
485
   `^-....____:   +.      {1}""".format(pykat.__version__, pykat_web)
Daniel Brown's avatar
Daniel Brown committed
486
487
488
489
490
491
492
493
    
    def loadKatFile(self, katfile):
        commands=open(katfile).read()
        self.parseCommands(commands)
    
    def parseKatCode(self, code):
        #commands = code.split("\n")
        self.parseCommands(code)
494
495
496
497
498
499
500
501
502

    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:
503
            values = line.split()
504
505
506
            
            if len(values)>0 and values[0] == 'const':
                
Daniel Brown's avatar
Daniel Brown committed
507
                if len(values) >= 3:
508
509
510
                    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
511
                        constants[str(values[1])] = Constant(values[1], values[2], [])
512
513
514
515
516
517
                else:
                    raise pkex.BasePyKatException('const command "{0}" was not the correct format'.format(line))
        
        commands_new = []
        
        for line in commands:
518
            values = line.split()
519
            
520
            if len(values) > 0 and values[0] != 'const':
521
522
523
                # check if we have a var/constant in this line
                if line.find('$') >= 0:
                    for key in constants.keys():
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
                        # 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):
539
540
541
542
543
544
545
546
                            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
547
548
549
550
551
        
    def parseCommands(self, commands):
        blockComment = False
        
        commands=self.remove_comments(commands)
552
553
        
        commands=self.processConstants(commands)
Daniel Brown's avatar
Daniel Brown committed
554
555
556
557
        
        after_process = [] # list of commands that should be processed after 
                           # objects have been set and created
        
558
        for line in commands:
Daniel Brown's avatar
Daniel Brown committed
559
560
561
562
563
            #for line in commands:
            if len(line.strip()) >= 2:
                line = line.strip()

                # Looking for block start or end
564
                values = line.split()
Daniel Brown's avatar
Daniel Brown committed
565
566
567
568
                if values[0] == "%%%":
                    if values[1] == "FTblock":
                        newTag = values[2]
                        
569
                        if self.__currentTag != None and self.__currentTag != NO_BLOCK: 
Daniel Brown's avatar
Daniel Brown committed
570
571
572
                            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
573
                            raise pkex.BasePyKatException("Block `{0}` has already been read".format(newTag))
Daniel Brown's avatar
Daniel Brown committed
574
575
                            
                        self.__blocks[newTag] = Block(newTag) # create new list to store all references to components in block
576
                        self.__currentTag = newTag
Daniel Brown's avatar
Daniel Brown committed
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
                        
                    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)
604
605
                elif(first == "sq"):
                    obj = pykat.components.squeezer.parseFinesseText(line)
Daniel Brown's avatar
Daniel Brown committed
606
607
608
609
610
611
612
613
614
615
                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
616
617
                elif(first[0:2] == "ad"):
                    obj = pykat.detectors.ad.parseFinesseText(line)
618
619
620
621
                elif(first[0:2] == "bp"):
                    obj = pykat.detectors.bp.parseFinesseText(line)
                elif(first[0:4] == "gouy"):
                    obj = pykat.detectors.gouy.parseFinesseText(line)
622
                elif(first[0:2] == "pd" and first != "pdtype"):
623
                    obj = pykat.detectors.pd.parseFinesseText(line)
624
                elif(first == "qshot" or first == "qshotS" or first == "qshotN"):
Daniel Brown's avatar
Daniel Brown committed
625
                    obj = pykat.detectors.qshot.parseFinesseText(line)
626
                elif(first == "qnoised" or first == "qnoisedS" or first == "qnoisedN"):
Daniel Brown's avatar
Daniel Brown committed
627
                    obj = pykat.detectors.qnoised.parseFinesseText(line)
Daniel Brown's avatar
Daniel Brown committed
628
629
630
631
632
633
                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)
634
635
                elif(first == "scale"):
                    after_process.append(line)
636
637
                elif(first == "pdtype"):
                    after_process.append(line)
Daniel Brown's avatar
Daniel Brown committed
638
639
                elif(first == "attr"):
                    after_process.append(line)
Daniel Brown's avatar
Daniel Brown committed
640
641
                elif(first == "noxaxis"):
                    self.noxaxis = True
642
643
644
                elif(first == "lambda"):
                    v = line.split()
                    self.lambda0 = SIfloat(v[-1])
645
646
647
648
                elif(first == "yaxis"):
                    v = line.split()
                    
                    self.yaxis = v[-1]
649
                elif(first == "phase"):
650
                    v = line.split()
651
                    if len(v) != 2:
652
                        raise pkex.BasePyKatException("phase command `{0}` is incorrect.".format(line))
653
654
                    else:
                        self.phase = int(v[1])
655
                elif(first == "maxtem"):
656
                    v = line.split()
657
658
659
                    if len(v) != 2:
                        raise pkex.BasePyKatException("maxtem command `{0}` is incorrect.".format(line))
                    else:
660
661
662
                        if v[1] == "off":
                        	self.maxtem = -1
                        else:
663
	                        self.maxtem = int(v[1])
Sean Leavey's avatar
Sean Leavey committed
664
665
666
667
668
669
                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]
670
                elif(first == "retrace"):
671
                    v = line.split()
Daniel Brown's avatar
Daniel Brown committed
672
                    if len(v) > 2:
673
                        raise pkex.BasePyKatException("Retrace command `{0}` is incorrect.".format(line))
Daniel Brown's avatar
Daniel Brown committed
674
                    elif len(v) == 2:
675
                        self.retrace = v[1]                        
676
                elif(first == "deriv_h"):
677
                    v = line.split()
678
                    if len(v) != 2:
679
                        raise pkex.BasePyKatException("deriv_h command `{0}` is incorrect.".format(line))
680
681
                    else:
                        self.deriv_h = float(v[1])
682
683
684
                elif(first == "gnuterm" or first == "pyterm"):
                    if self.verbose:
                        print "Ignoring Gnuplot/Python terminal command '{0}'".format(line)
685
686
687
688
689
                #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
690
691
692
                else:
                    if self.verbose:
                        print "Parsing `{0}` into pykat object not implemented yet, added as extra line.".format(line)
693
                        
Daniel Brown's avatar
Daniel Brown committed
694
695
696
697
698
                    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):
699
700
                    if self.hasNamedObject(obj.name):
                        getattr(self, obj.name).remove()
701
                        print "Removed existing object '{0}' of type {1} to add line '{2}'".format(obj.name, obj.__class__, line)
702
                        
Daniel Brown's avatar
Daniel Brown committed
703
704
                    self.add(obj)
                    
705
                    
Daniel Brown's avatar
Daniel Brown committed
706
707
708
        # 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:
709
            first = line.split(" ",1)[0]            
Daniel Brown's avatar
Daniel Brown committed
710
            if first == "gauss" or first == "gauss*" or first == "gauss**":
711
                pykat.commands.gauss.parseFinesseText(line, self)
712
            elif (first == "scale"):
713
                v = line.split()
714
715
716
717
718
                if len(v) == 3:
                    component_name = v[2]
                    if component_name in self.__detectors :
                        self.__detectors[component_name].scale = SIfloat(v[1])
                    else:
719
                        raise pkex.BasePyKatException("scale command `{0}` refers to non-existing output".format(component_name))
720
721
722
723
724
                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])
725
                else:
726
                    raise pkex.BasePyKatException("scale command `{0}` is incorrect.".format(line))
727
            elif (first == "pdtype"):
728
                v = line.split()
729
730
731
                if len(v) == 3:
                    component_name = v[1]
                    if component_name in self.__detectors :
Andreas Freise's avatar
Andreas Freise committed
732
                        self.__detectors[component_name].pdtype = v[2]
733
                    else:
734
                        raise pkex.BasePyKatException("pdtype command `{0}` refers to non-existing detector".format(component_name))
735
                else:
736
                    raise pkex.BasePyKatException("pdtype command `{0}` is incorrect.".format(line))
Daniel Brown's avatar
Daniel Brown committed
737
738
            elif(first == "attr"):
                v = line.split()
739

Daniel Brown's avatar
Daniel Brown committed
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
                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)
758
                    
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
            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
774
        self.__currentTag = NO_BLOCK 
775
        
Daniel Brown's avatar
Daniel Brown committed
776
777
778
779
780
781
782
783
784
785
786
787
788
    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
789

Daniel Brown's avatar
Daniel Brown committed
790
            
Daniel Brown's avatar
Daniel Brown committed
791
792
793
794
795
796
797
798
    def getProcess(self, callback, **kwargs):
        """
        """
        
        cmd = "\n".join(self.generateKatScript())
        
        return Process(target=f__lkat_process, args=(callback, cmd, kwargs))
           
799
    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
800
801
802
803
        """ 
        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
804
        printout=1 prints the Finesse banner
805
        printerr shows the Finesse progress (set kat.verbose=1 to see warnings and errors)
Daniel Brown's avatar
Daniel Brown committed
806
807
808
809
810
811
812
813
814
815
816
817
        """
        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 :
818
                    raise pkex.MissingFinesseEnvVar()
Daniel Brown's avatar
Daniel Brown committed
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
            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)):
834
                raise pkex.MissingFinesse()
Daniel Brown's avatar
Daniel Brown committed
835
836
837
838
                
            if self.verbose: print "--------------------------------------------------------------"
            if self.verbose: print "Running kat - Started at " + str(start)
            
839
            if hasattr(self, "x2axis") and self.noxaxis == False:
Daniel Brown's avatar
Daniel Brown committed
840
841
842
843
                r = katRun2D()
            else:
                r = katRun()
                
844
            r.yaxis = self.yaxis
Daniel Brown's avatar
Daniel Brown committed
845
            r.katScript = "".join(self.generateKatScript())   
846
847
848
849
850
851
852
853

            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
854
855
856
857
858
859
860
861
862
863
            
            # 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()
864

865
            if printout == 1 or plot != None:
866
867
868
                cmd=[kat_exec]
            else:
                cmd=[kat_exec, '--perl1']
Daniel Brown's avatar
Daniel Brown committed
869
870
871
872
873
874
875
876
877
878
            
            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)
879
                            
Daniel Brown's avatar
Daniel Brown committed
880
881
882
            p=subprocess.Popen(cmd, shell=False, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
            err = ""
            
Andreas Freise's avatar
Andreas Freise committed
883
            #if self.verbose: print "Finesse output:"
884

Daniel Brown's avatar
Daniel Brown committed
885
886
            for line in iter(p.stderr.readline, ""):
                
887
                if len(line) > 0:
Daniel Brown's avatar
Daniel Brown committed
888
                    
889
890
891
892
893
894
895
896
897
898
                    if line.lstrip().startswith('**'):
                        if self.verbose: sys.stdout.write(line)  
                    elif line.rstrip().endswith('s'):
                        vals = line.split("-")
                        action = vals[0].strip()
                        prc = vals[1].strip()[:]
                    
                        if printerr == 1:
                            sys.stdout.write("\r{0} {1}".format(action, prc))
                            
Daniel Brown's avatar
Daniel Brown committed
899
900
901
902
903
904
905
906
                    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))
                            
907
908
                    elif line[0:3] == '** ':
                        if self.verbose: sys.stdout.write(line)
909
910
                    else:
                        err += line
911

Daniel Brown's avatar
Daniel Brown committed
912
            
Daniel Brown's avatar
Daniel Brown committed
913
            [out,errpipe] = p.communicate()
914
            
915
916
            if printout == 1: 
                print out
Andreas Freise's avatar
Andreas Freise committed
917
918
            else:
                if printerr == 1: print ""
919

Daniel Brown's avatar
Daniel Brown committed
920
921
922
923
924
925
            # get the version number
            ix = out.find('build ') + 6
            ix2 = out.find(')',ix)
            r.katVersion = out[ix:ix2]
            
            r.runDateTime = datetime.datetime.now()
926
927

            # If Finesse returned an error, just print that and exit!
Daniel Brown's avatar
Daniel Brown committed
928
            if p.returncode != 0:
929
930
                print err
                sys.exit(1) 
Daniel Brown's avatar
Daniel Brown committed
931
            
932
933
            self.__prevrunfilename = katfile.name
            
Daniel Brown's avatar
Daniel Brown committed
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
            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)
            
951
            if hasattr(self, "x2axis") and self.noxaxis == False:
Daniel Brown's avatar
Daniel Brown committed
952
953
954
955
956
                [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:])
957
                         
Daniel Brown's avatar
Daniel Brown committed
958
959
960
961
962
            else:
                [r.x,r.y,hdr] = self.readOutFile(outfile)
            
                r.xlabel = hdr[0]
                r.ylabels = map(str.strip, hdr[1:])
963
                    
Daniel Brown's avatar
Daniel Brown committed
964
965
966
967
968
969
970
971
972
973
974
975
976
977
            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
978
979
980
981
982
983
984
985
            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
986
                print out[out.find(' ---') :]
Daniel Brown's avatar
Daniel Brown committed
987
988
989
990
991
992
993
994

            katfile.close()
            perfData = []
            
            if self.__time_code:
                perffile = open(root[0] + ".perf",'r')
                
                for l in perffile.readlines():
995
                    vals = l.strip().split()
Daniel Brown's avatar
Daniel Brown committed
996
997
998
999
1000
                    perfData.append((vals[0], float(vals[1]), float(vals[2]), float(vals[3])))
                    
                return [r, perfData]
            else:
                return r